Error Handling
Mandate related errors are communicated to merchants through both a state_reason and a latest_error object that provide additional context required to handle unhappy path scenarios.
Definitions:
state_reason: Provides context on any change in Mandate or Payment state for any reason.
latest_error: Provides context when a change in Mandate or Payment state is the result of error.
Mandate Errors:
| Reason / Error Code | Context |
|---|---|
| MANDATE_INELIGIBLE_AMOUNT | A payment failed because the amount was outside the parameters of the mandate agreement. |
| MANDATE_INELIGIBLE_COUNT | A payment failed because the transaction limit in the mandate agreement was exceeded. |
| MANDATE_EXPIRED | The mandate agreement has expired. |
| MANDATE_INACTIVE | The mandate is not active or has been suspended. |
| MANDATE_INELIGIBLE | The payment contents do not align with the agreement terms. |