API Codes

Learn about the API Codes returned by our Cashouts APIs

Cashout Status Codes

Code
Meaning
Description

0

The cashout was accepted by OKP but it wasn't sent to the bank yet. It can still be Canceled. See Cancel Cashout

1

The money reached the customer's account

2

The cashout was cancelled by you

3

The cashout was rejected by the bank due to invalid bank account, account closed, etc.

4

The cashout was sent to the bank for processing. At this point it can't be cancelled anymore

5

Cashout set to on hold by you. It won't be processed until manually changed again to Pending status

Cashout Rejection Error Codes

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

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

565

The bank is not licensed to process this transaction

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

Reason Code
HTTP Code
Type
Message
Description

101

400

USER_REJECTED_KYC_CHECK

Transaction related to blacklisted user.

The transaction was rejected because one of its attributes was related to a blacklisted user

102

400

USER_REJECTED_KYC_CHECK

Email risk

High risk detected by our fraud prevention engine related to the user's email address

103

400

USER_REJECTED_KYC_CHECK

Credit card risk

High risk detected by our fraud prevention engine related to the credit card used

104

400

USER_REJECTED_KYC_CHECK

User rejected after KYC check

User rejected by our KYC controls

105

400

USER_REJECTED_KYC_CHECK

Underage user detected

User does not meet the minimum age requirement

106

400

USER_REJECTED_KYC_CHECK

Mismatch between user name and document name

The user's name does not match the name associated with the document provided

107

400

USER_REJECTED_KYC_CHECK

Document status is not OK

Some irregularities have been detected while validating the document information

108

400

USER_REJECTED_KYC_CHECK

PEP user detected

The user is a Politically Exposed Person (PEP)

109

400

USER_REJECTED_KYC_CHECK

High risk detected

High risk detected by our fraud prevention engine

110

400

USER_REJECTED_KYC_CHECK

Failed biometric check

Something went wrong while performing the biometric check on the user

111

400

USER_REJECTED_KYC_CHECK

Failed OTP verification

Something went wrong while performing the OTP check on the user

112

400

USER_REJECTED_KYC_CHECK

3DS Authentication failed

Transaction rejected due to failed 3DS

113

400

USER_REJECTED_KYC_CHECK

Document does not exist

Invalid Document

114

400

USER_REJECTED_KYC_CHECK

User rejected after CNPJ validations

Invalid/Irregular CNPJ (Brasil Only)

115

400

USER_REJECTED_KYC_CHECK

Invalid document format

Format of the provided document is invalid. (Mexico Only)

116

400

USER_REJECTED_KYC_CHECK

Sportsman User

Sportsman User

117

400

USER_REJECTED_KYC_CHECK

Related to Sportsman User

Related to Sportsman User

118

400

USER_REJECTED_KYC_CHECK

National Sanction List

User has been identified on national sanction lists

119

400

USER_REJECTED_KYC_CHECK

International Sanction Lists

User has been identified on international sanction lists

120

400

USER_REJECTED_KYC_CHECK

Regulatory reasons

Rejected due to regulatory reasons

121

400

USER_REJECTED_KYC_CHECK

Velocity check

Rejected due to velocity check

Last updated