Description of error codes with respective suggested actions.
| Error string | Error Message | HTTP Status Code | Action |
|---|---|---|---|
| UNKNOWN_ERROR | An error occurred | 500 | Retry |
| RESOURCE_NOT_FOUND | The resource was not found | 404 | Re-check parameters |
| UNAVAILABLE_PROVIDER | The provider is not available | 502 | Retry |
| PROVIDER_UNEXPECTED_ERROR | The provider returned an unexpected error | 502 | Retry |
| PROVIDER_TIMEOUT_ERROR | The provider timed out | 504 | Retry |
| INSUFFICIENT_FUNDS | Insufficient funds | 402 | Requires more cash ins events before retrying any cash out/ refund again. |
| INVALID_PAYMENT_METHOD | Payment method is invalid | 400 | Retry after fixing the paymentMethod field for the transaction. |
| INVALID_PARAMETERS | Invalid parameters | 400 | Read the message to see what went wrong, fix it, then retry. |
| DUPLICATED_PAYMENT | Duplicated payment | 500 | Retry in 2 hours. |
| THIRD_PARTY_TRANSACTION | Third party transaction is not allowed | 500 | The payment or payout was blocked due to AML reasons. Do not retry. |
| INVALID_PIX_KEY | The PIX Key informed is not valid | 500 | The Pix key doesn't exist or it is completely invalid. Please correct it and send again. Don't ever retry with the same data. |
| SANCTIONED_USER | The user is sanctioned | 451 | Customer blocked due to AML. Do not retry. |
| GLOBALLY_SANCTIONED_USER | The user is globally sanctioned | 451 | Customer blocked due to AML. Do not retry. |
| REJECTED_BY_RECEIVING_PARTY | The receiving party rejected the transaction | 502 | Payment was rejected by the receiving bank. Request another bank account to customer. |
| CANCELED_BY_USER | The user canceled the transaction | 500 | - |
| RECEIVING_PARTY_TIMEOUT | The receiving party timed out | 504 | Retry |
| INVALID_AMOUNT | The amount is invalid | 400 | Fix amount and retry. |
| TOO_MANY_TRANSACTIONS | Too many transactions | 429 | Retry in 2 hours. |
| LIMIT_EXCEEDED | The limit was exceeded | 500 | Retry in one day. |
| INVALID_RECEIVING_INSTITUTION | The receiving institution is invalid | 500 | Re-check the bank code. |
| TRANSACTION_NOT_ELIGIBLE_FOR_REFUND | The transaction is not eligible for refund | 400 | Do not retry. |