# API Codes

## **Cashout Status Codes**

| Code |                                                                       Meaning                                                                      | Description                                                                                                                                                                                                             |
| :--: | :------------------------------------------------------------------------------------------------------------------------------------------------: | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|   0  | <img src="https://content.gitbook.com/content/7aIgg5dys0yN8otrASQq/blobs/9bk9IRTPIeloZeWBACdl/Untitled%20Diagram.svg" alt="" data-size="original"> | The cashout was accepted by OKP but it wasn't sent to the bank yet. It can still be Canceled. See [Cancel Cashout](https://apidocs.onekeypayments.com/api-documentation/cashouts-api/endpoints/cashout-cancel-endpoint) |
|   1  |      <img src="https://content.gitbook.com/content/7aIgg5dys0yN8otrASQq/blobs/BmTowydz71dcnVReLfDD/COMPLETED.svg" alt="" data-size="original">     | The money reached the customer's account                                                                                                                                                                                |
|   2  |      <img src="https://content.gitbook.com/content/7aIgg5dys0yN8otrASQq/blobs/HmcBguazdaJXcWZoRZIU/CANCELLED.svg" alt="" data-size="original">     | The cashout was cancelled by you                                                                                                                                                                                        |
|   3  |      <img src="https://content.gitbook.com/content/7aIgg5dys0yN8otrASQq/blobs/TEzrH1I5WI4AXeMZvTSe/REJECTED.svg" alt="" data-size="original">      | The cashout was rejected **by the bank** due to invalid bank account, account closed, etc.                                                                                                                              |
|   4  |      <img src="https://content.gitbook.com/content/7aIgg5dys0yN8otrASQq/blobs/AVwhCOWPLESLW9Vj3Hbv/DELIVERED.svg" alt="" data-size="original">     | The cashout was sent to the bank for processing. At this point it can't be cancelled anymore                                                                                                                            |
|   5  |                         ![](https://content.gitbook.com/content/7aIgg5dys0yN8otrASQq/blobs/dYHsvFUy5KwEOdu7nGKi/image.png)                         | Cashout set to on hold by you. It won't be processed until manually changed again to Pending status                                                                                                                     |

## **Cashout Rejection Error Codes**

&#x20;The error information is the one (if) provided by the Bank.

| Code | Name                                    | Description                                                          |
| ---- | --------------------------------------- | -------------------------------------------------------------------- |
| 800  | `ERROR_ACCOUNT_INCORRECT`               | Invalid bank account                                                 |
| 801  | `ERROR_ACCOUNT_CLOSED`                  | Bank account is closed                                               |
| 802  | `ERROR_AMOUNT_INCORRECT`                | Invalid amount                                                       |
| 803  | `ERROR_BANK_INVALID`                    | Invalid bank code                                                    |
| 804  | `ERROR_BANK_BRANCH_INCORRECT`           | Invalid bank branch                                                  |
| 805  | `ERROR_BENEFICIARY_DOCUMENT_ID_INVALID` | Invalid beneficiary document                                         |
| 806  | `ERROR_BENEFICIARY_NAME_INCORRECT`      | Beneficiary name doesn't match bank details                          |
| 807  | `ERROR_REJECTED_BY_BANK`                | Rejected by bank                                                     |
| 808  | `ERROR_OTHER`                           | Other error                                                          |
| 809  | `WITHDRAWAL_EXPIRED`                    | Withdrawal expired                                                   |
| 810  | `LIMIT_EXCEEDED`                        | Beneficiary limit exceeded                                           |
| 811  | `RISK_POLICY`                           | Violates bank risk policy                                            |
| 812  | `BLOCKED_FROZEN_ACCOUNT`                | Bank account blocked/frozen                                          |
| 813  | `DOCUMENT_ACCOUNT_MISMATCH`             | Beneficiary document doesn't match bank details                      |
| 814  | `INVALID_PIX_KEY`                       | Invalid Pix Key                                                      |
| 815  | `INVALID_IFSC_CODE`                     | Invalid IFSC code                                                    |
| 816  | `INVALID_ACCOUNT_OR_IFSC_CODE`          | Invalid bank account or IFSC code                                    |
| 817  | `INVALID_NBIN`                          | Invalid NBIN                                                         |
| 818  | `ACCOUNT_UNABLE`                        | The bank account is unable to receive transfers                      |
| 819  | `INVALID_ACCOUNT_TYPE`                  | Invalid bank account type                                            |
| 820  | `REJECTED_BY_MERCHANT_REQUEST`          | Rejected by  merchant's request                                      |
| 823  | `REJECTED_BY_MERCHANT_REQUEST`          | Email field cannot be empty                                          |
| 827  | `BANK_NOT_REGULATED`                    | The bank is not licensed to process this transaction                 |
| 828  | `UNMATCHED_BANK_ACCOUNT`                | The PIX key details do not match any of the registered bank accounts |

## **Cashout Internal Error Codes**

| Code | Description                                                                                                                                                                               |
| ---- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 300  | Invalid params + \[param name] + \[reason]                                                                                                                                                |
| 302  | Invalid control string. [Click here for instructions](https://apidocs.onekeypayments.com/api-documentation/cashouts-api/technical-and-security-aspects/calculating-the-payload-signature) |
| 303  | Invalid bank code                                                                                                                                                                         |
| 401  | Invalid credentials                                                                                                                                                                       |
| 402  | Unregistered IP address (Go to API Access to whitelist the IP in the Merchant Panel)                                                                                                      |
| 502  | Invalid request body  -  Please check that the JSON is well formatted                                                                                                                     |
| 503  | The transaction cannot be processed as the user has reached their financial capacity, please provide proof of winnings                                                                    |
| 504  | User unauthorized due to cadastral situation.                                                                                                                                             |
| 508  | Limit exceeded: {TRANSACTION\|DAILY\|MONTHLY\|USER MONTHLY QUANTITY}                                                                                                                      |
| 509  | Cashout not found with this ID                                                                                                                                                            |
| 510  | Invalid status: cashout is not Pending                                                                                                                                                    |
| 511  | External ID already used                                                                                                                                                                  |
| 514  | Insufficient funds                                                                                                                                                                        |
| 515  | Invalid user status: {BLACKLISTED\|BLOCKED\|SUSPENDED}                                                                                                                                    |
| 518  | Country not available                                                                                                                                                                     |
| 519  | Merchant not enabled. Contact your Account Manager                                                                                                                                        |
| 524  | Invalid Credentials. Contact <integration@onekeypayments.com>                                                                                                                             |
| 525  | Close loop rejection                                                                                                                                                                      |
| 526  | Invalid currency                                                                                                                                                                          |
| 533  | Invalid Amount. The minimum amount is {currency} {amount} or equivalent in USD                                                                                                            |
| 537  | Could not make the cashout. Contact <integration@onekeypayments.com>                                                                                                                      |
| 538  | Invalid account status: {BLACKLISTED}                                                                                                                                                     |
| 539  | Payout method unavailable. The country and/or bank selected is not available. Please check with your Account Manager                                                                      |
| 540  | Beneficiary email or phone is required                                                                                                                                                    |
| 541  | email already used by another beneficiary                                                                                                                                                 |
| 542  | phone already used by another beneficiary                                                                                                                                                 |
| 543  | must be a[ valid phone number](https://apidocs.onekeypayments.com/knowledge-base/countries-specifications#phone-numbers-validations)                                                      |
| 565  | The bank is not licensed to process this transaction                                                                                                                                      |
| 566  | Bank Code disabled                                                                                                                                                                        |
| 702  | Could not cancel cashout                                                                                                                                                                  |
| 703  | Could not make the cashout. Contact <integration@onekeypayments.com>                                                                                                                      |

## **Cashout Status Rejection Error Codes**

The error information is the one (if) provided by the Bank.

| Code | Name                                                | Description                                             |
| ---- | --------------------------------------------------- | ------------------------------------------------------- |
| 510  | `Invalid status transition`                         | Status transition does not meet cashout status workflow |
| 509  | `Cashout not found with this ID`                    | There is no cashout under provided ID                   |
| 521  | `Status ... not supported for this type of request` | Provided Status does not exist                          |

### Fraud Reason Codes for KYC Errors&#x20;

<table data-full-width="true"><thead><tr><th width="179" align="center">Reason Code</th><th width="128" align="center">HTTP Code</th><th width="203" align="center">Type</th><th width="162">Message</th><th width="162">Description</th></tr></thead><tbody><tr><td align="center">101</td><td align="center">400</td><td align="center"><code>USER_REJECTED_KYC_CHECK</code></td><td>Transaction related to blacklisted user.</td><td>The transaction was rejected because one of its attributes was related to a blacklisted user</td></tr><tr><td align="center">102</td><td align="center">400</td><td align="center"><code>USER_REJECTED_KYC_CHECK</code></td><td>Email risk</td><td>High risk detected by our fraud prevention engine related to the user's email address</td></tr><tr><td align="center">103</td><td align="center">400</td><td align="center"><code>USER_REJECTED_KYC_CHECK</code></td><td>Credit card risk</td><td>High risk detected by our fraud prevention engine related to the credit card used</td></tr><tr><td align="center">104</td><td align="center">400</td><td align="center"><code>USER_REJECTED_KYC_CHECK</code></td><td>User rejected after KYC check</td><td>User rejected by our KYC controls</td></tr><tr><td align="center">105</td><td align="center">400</td><td align="center"><code>USER_REJECTED_KYC_CHECK</code></td><td>Underage user detected</td><td>User does not meet the minimum age requirement</td></tr><tr><td align="center">106</td><td align="center">400</td><td align="center"><code>USER_REJECTED_KYC_CHECK</code></td><td>Mismatch between user name and document name</td><td>The user's name does not match the name associated with the document provided</td></tr><tr><td align="center">107</td><td align="center">400</td><td align="center"><code>USER_REJECTED_KYC_CHECK</code></td><td>Document status is not OK</td><td>Some irregularities have been detected while validating the document information</td></tr><tr><td align="center">108</td><td align="center">400</td><td align="center"><code>USER_REJECTED_KYC_CHECK</code></td><td>PEP user detected</td><td>The user is a Politically Exposed Person (PEP)</td></tr><tr><td align="center">109</td><td align="center">400</td><td align="center"><code>USER_REJECTED_KYC_CHECK</code></td><td>High risk detected</td><td>High risk detected by our fraud prevention engine</td></tr><tr><td align="center">110</td><td align="center">400</td><td align="center"><code>USER_REJECTED_KYC_CHECK</code></td><td>Failed biometric check</td><td>Something went wrong while performing the biometric check on the user</td></tr><tr><td align="center">111</td><td align="center">400</td><td align="center"><code>USER_REJECTED_KYC_CHECK</code></td><td>Failed OTP verification</td><td>Something went wrong while performing the OTP check on the user</td></tr><tr><td align="center">112</td><td align="center">400</td><td align="center"><code>USER_REJECTED_KYC_CHECK</code></td><td>3DS Authentication failed</td><td>Transaction rejected due to failed 3DS</td></tr><tr><td align="center">113</td><td align="center">400</td><td align="center"><code>USER_REJECTED_KYC_CHECK</code></td><td>Document does not exist</td><td>Invalid Document</td></tr><tr><td align="center">114</td><td align="center">400</td><td align="center"><code>USER_REJECTED_KYC_CHECK</code></td><td>User rejected after CNPJ validations</td><td>Invalid/Irregular CNPJ (Brasil Only)</td></tr><tr><td align="center">115</td><td align="center">400</td><td align="center"><code>USER_REJECTED_KYC_CHECK</code></td><td>Invalid document format</td><td>Format of the provided document is invalid. (Mexico Only)</td></tr><tr><td align="center">116</td><td align="center">400</td><td align="center"><code>USER_REJECTED_KYC_CHECK</code></td><td>Sportsman User</td><td>Sportsman User</td></tr><tr><td align="center">117</td><td align="center">400</td><td align="center"><code>USER_REJECTED_KYC_CHECK</code></td><td>Related to Sportsman User</td><td>Related to Sportsman User</td></tr><tr><td align="center">118</td><td align="center">400</td><td align="center"><code>USER_REJECTED_KYC_CHECK</code></td><td>National Sanction List</td><td>User has been identified on national sanction lists</td></tr><tr><td align="center">119</td><td align="center">400</td><td align="center"><code>USER_REJECTED_KYC_CHECK</code></td><td>International Sanction Lists</td><td>User has been identified on international sanction lists</td></tr><tr><td align="center">120</td><td align="center">400</td><td align="center"><code>USER_REJECTED_KYC_CHECK</code></td><td>Regulatory reasons</td><td>Rejected due to regulatory reasons</td></tr><tr><td align="center">121</td><td align="center">400</td><td align="center"><code>USER_REJECTED_KYC_CHECK</code></td><td>Velocity check</td><td>Rejected due to velocity check</td></tr></tbody></table>
