API Codes
Learn about the API Codes returned by our APIs
Deposits Status Codes
The status of the deposits are separated into different and very specific categories for you to better handle and know the behavior of your customers.
The deposit is created but the customer hasn't opened the link yet.
The deposit is created and the customer has opened the link but he/she didn't complete the payment flow (select payment method, complete personal details, confirm details) or the provider was unable to process the request.
The deposit is created with all the information required and it is awaiting on customer's payment. It has been marked by you to release it earlier. Please note that the customer hasn't paid yet and the money won't be credited to your balance until the customer's payment is detected.
The deposit is created with all the information required and it is awaiting on customer's payment.
The deposit didn't pass our anti-fraud systems and will be retained until manual review.
The deposit has reached its expiration time and the user didn't pay.
The deposit has been cancelled by the customer or it has been 7 days after the expiration.
The deposit was paid by the customer but it still hasn't arrived the payer's crypto wallet. Only used for crypto payments.
The deposit has been completed and the money was credited to your account or to the payer's crypto wallet.
Use the Deposit Status Endpoint to retrieve the status of a refund.
Refunds Status Codes
The refund is created and is pending to be processed. It can still be cancelled.
The refund is pending for you to provide more information. It can still be cancelled.
The refund has been sent to the bank for processing. It can't be cancelled anymore.
The refund has been manually cancelled. Final status.
The refund has been rejected by the bank. Final status.
The refund has been completed. Final status.
Use the Refund Status Endpoint to retrieve the status of a refund.
API Error Codes
Categories
We group the error codes into different categories for better understanding.
1xx- Header errors2xx- Merchant/request validations errors3xx- User errors4xx- Create deposit errors5xx- Other errors7xx- Internal errors8xx- Refund errors9xx- Credit Card errors
Deposit API Error Codes
100
401
INVALID_CREDENTIALS
Invalid Credentials
The X-Login you sent is incorrect or it is not yet active
101
400
MISSING_REQUIRED_HEADER
Missing or invalid format for required header {headerName}
Make sure all the headers are correct. Click here for details
102
400
INVALID_SIGNATURE
Invalid signature
Invalid Authorization signature. Click here for instructions
103
400
INVALID_DATE_RANGE
X-Date header value out of valid range
The X-Date value you sent in the header is outside the allowed time-frame. Click here for details
104
400
IDEMPOTENCY_KEY_ALREADY_USED
Idempotency key {key} has been already used
The X-Idempotency-Key you sent has already been used
105
400
EMPTY_HEADER_VALUE
Optional header {headerName} must not be blank
If an optional header is sent, it can't be blank
200
405
METHOD_NOT_ALLOWED
Method not allowed
The request method used is not allowed. Click here for endpoints instructions
201
400
BEAN_VALIDATION_ERROR
Field validation error. Check details
One or more fields sent were incorrect
202
401
INVALID_IP
Unregistered IP address
You must whitelist your IP Address. Click here for instructions
203
429
VELOCITY_CHECK
Too many consecutive attempts for user (Velocity Check)
The user has created many deposits in a short period of time
204
400
INVALID_MEDIA_TYPE
Invalid media type
The payload format is in an unsupported format. Make sure the header Content-Type is application/json
205
400
MISSING_REQUEST_PARAMETER
Missing request parameter
The request is missing an important parameter
206
400
MISSING_PATH_VARIABLE
Missing path variable
The request is missing an important path variable
207
400
INVALID_REQUEST_PARAMETER_TYPE
Invalid request parameter type
A parameter type sent was incorrect
208
404
RESOURCE_NOT_FOUND
Resource not found
The deposit_id being used doesn't exist
209
400
INVALID_REQUEST_BODY
Invalid request body: {details}
There is a syntax error in the JSON payload
217
403
FORBIDDEN_MERCHANT
Merchant has no authorization to use this API
Your Merchant Account is not enabled to use this API. Contact your Account Manager for more information
218
400
CRYPTO_NOT_ALLOWED_FOR_MERCHANT
Wrong merchant routing type for crypto payments
Your Merchant Account is not enabled to use the Crypto functionality. Contact your Account Manager for more information
300
400
USER_BLACKLISTED
User blacklisted
The user is known for committing fraud
301
400
USER_GREYLISTED
User greylisted
The user is banned because we detected suspicious behavior
302
400
USER_UNAUTHORIZED
User unauthorized
The user is blocked. For further information go to the "Clients" section on the Merchant Panel
303
400
USER_UNAUTHORIZED_REG_STATUS
User unauthorized due to cadastral situation
Check the user's cadastral situation
304
400
USER_LIMIT_EXCEEDED
The user limit has been exceeded: {TRANSACTION|DAILY|WEEKLY|MONTHLY}
Check the user's limit on the Merchant Panel under the "Clients" section
305
400
PAYMENT_METHOD_RESTRICTED
Restricted payment method type
The payment type is disallowed for the payer
306
400
FINANCIAL_CAPACITY
The transaction cannot be processed as the user has reached their financial capacity, please provide proof of funds
The transaction cannot be processed as the user has reached their financial capacity, please provide proof of funds
400
400
INVALID_AMOUNT
Invalid amount. The minimum is USD 2 or equivalent in local currency
The amount does not reach the minimum limit of USD 2
401
400
PAYMENT_METHOD_NOT_FOUND
Payment method not found
The payment_method_code sent isn't correct, or the Payment Method isn't enabled for your Merchant account. Use the payment_methods API to diagnose this error
402
400
INVOICE_ALREADY_USED
Invoice already used
The invoice_id sent has already been used
403
400
INVALID_BANK_CODE
Invalid bank code: {code}
The bank_code sent is invalid
404
400
ERROR_CREATING_PAYMENT
Payment method provider unavailable
Our provider is temporarily unavailable. Use a different payment method or try again
406
400
INVALID_ADDRESS
Invalid address
The address sent is invalid
407
400
INVALID_CITY
Invalid city
The city sent is invalid
408
400
PAYMENT_METHOD_LIMIT_EXCEEDED
Payment method limit exceeded
The amount sent exceeds the provider's payment method limit. Try with a smaller amount
410
400
PAYMENT_METHOD_MINIMUM_REQUIRED
Payment method minimum required
The amount sent is smaller than the provider's payment method minimum limit. Try with a bigger amount
411
400
INVALID_USER_DOCUMENT
Invalid user document ID
The document_id specified was rejected by the provider itself. Check it is valid
412
400
PAYMENT_METHOD_UNAVAILABLE
Payment Method Unavailable
The payment method is temporarily unavailable, please try again later
413
400
INVALID_REPORTED_INFO_BANK_BENEFICIARY
Invalid reportedInfo.bankBeneficiary value
The value sent in the field reported_info.bank_beneficiary is invalid. Check validations
414
400
MISSING_REPORTED_INFO
Missing reportedInfo attribute
There are missing values for the reported_info object. Check requirements
415
400
INVALID_REPORTED_INFO_BANK_BRANCH
Invalid reportedInfo.bankBranch value
The value sent in the field reported_info.bankBranch is invalid. Check validations
416
400
INVALID_REPORTED_INFO_BANK_ACCOUNT_NUMBER
Invalid reportedInfo.bankAccountNumber value
The value sent in the field reported_info.bankAccountNumber is invalid. Check validations
417
400
INVALID_REPORTED_INFO_ACCOUNT_TYPE
Invalid reportedInfo.bankAccountType value
The value sent in the field reported_info.bankAccountType is invalid. Check validations
418
400
MISSING_REQUIRED_FIELDS
Missing required fields in order to generate Deposit
The request is missing a required field. Please check here.
419
400
MISSING_PAYER_ID_OR_DOCUMENT
payer.id or payer.document field is missing
The request is missing the payer.id or payer.document field and at least one of them is mandatory to create the deposit
500
500
GENERIC_ERROR
Oh no! Something has gone wrong. Please contact a system administrator
Internal error, please contact support
511
400
NO_PAYMENT_METHODS_AVAILABLE
No payment methods available
Please contact your AM regarding payment methods’ availability
720
400
MISSING_CONFIGURATION
Missing configuration for merchant account
Please contact your AM/TAM
Refund API Error Codes
800
400
REFUND_NOT_ENABLED
Refund is not enabled
Your Merchant account doesn't have the refund capability enabled. Check with your Account Manager
801
400
DEPOSIT_NOT_COMPLETED
Refund cannot be applied since deposit is not in status completed
The refunds can only be applied over COMPLETED deposits
802
400
INVALID_AMOUNT_TO_REFUND
Amount to refund not valid
The amount to refund is not valid. Check if the amount is negative or bigger than the deposit itself.
803
400
INSUFFICIENT_FUNDS
Insufficient funds
Your Merchant account doesn't have enough funds to cover for the refund amount
804
400
MISSING_BANK_ACCOUNT
Missing bank account information
The bank account information is missing
805
400
ERROR_IN_REFUND
Error, the refund was not processed. {details}
The refund could not be completed. Flag it for review on our Merchant Panel for further information
PCI Deposit API Error codes
421
400
INSTALLMENTS_NOT_ENABLED
Merchant {MID} does not support installments for country {iso}.
Your merchant account is not allowed to create deposits with installments in that country.
422
400
INSTALLMENTS_QUANTITY_INVALID
Merchant {MID} installments quantity is invalid for country {iso code}. Requested {number}, allowed [{quantity of installments allowed}].
The amount of installments requested is not allowed for your merchant account in that country. Please check the allowed quantity.
900
400
CREDIT_CARD_BIN_NOT_FOUND
Invalid credit card bin
We were unable to find a valid issuer with the first 6 digits of the card
Fraud Reason Codes for KYC Errors
The reasons below are shown whenever the deposit is declined with type USER_REJECTED_KYC_CHECK or DEPOSIT_REJECTED_FRAUD_CHECK
400
101
Transaction related to blacklisted user.
The transaction was rejected because one of its attributes was related to a blacklisted user
400
102
Email risk
High risk detected by our fraud prevention engine related to the user's email address
400
103
Credit card risk
High risk detected by our fraud prevention engine related to the credit card used
400
104
User rejected after KYC check
User rejected by our KYC controls
400
105
Underage user detected
User does not meet the minimum age requirement
400
106
Mismatch between user name and document name
The user's name does not match the name associated with the document provided
400
107
Document status is not OK
Some irregularities have been detected while validating the document information
400
108
PEP user detected
The user is a Politically Exposed Person (PEP)
400
109
High risk detected
High risk detected by our fraud prevention engine
400
110
Failed biometric check
Something went wrong while performing the biometric check on the user
400
111
Failed OTP verification
Something went wrong while performing the OTP check on the user
400
112
3DS Authentication failed
Transaction rejected due to failed 3DS
400
113
Document does not exist
Invalid Document
400
114
User rejected after CNPJ validations
Invalid/Irregular CNPJ (Brasil Only)
400
115
Invalid document format
Document format rejections
400
116
Sportsman User
Sportsman User
400
117
Related to Sportsman User
Related to Sportsman User
400
118
National Sanction Lists
User has been identified on national sanction lists
400
119
International Sanction Lists
User has been identified on international sanction lists
400
120
Regulatory reasons
Rejected due to regulatory reasons
400
121
Velocity check
Rejected due to velocity check
Last updated
