API Codes

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.

Status	Description
​	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.
​	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 has been completed and the money was credited to your account.

API Error Codes

Categories

We group the error codes into different categories for better understanding.

• 1xx - Header errors

• 2xx - Merchant/request validations errors

• 3xx - User errors

• 4xx - Create deposit errors

• 5xx - Other errors

• 7xx - Internal errors

Deposit API Error Codes

API Code	HTTP Code	Type	Message	Description
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
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
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 Tupay 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 Tupay Panel under the "Clients" section
305	400	PAYMENT_METHOD_RESTRICTED	Restricted payment method type	The payment type is disallowed for the payer
400	400	INVALID_AMOUNT	Invalid amount. The minimum is USD 2 or equivalent in local currency	The amount does not reach the minimum limit
401	400	PAYMENT_METHOD_NOT_FOUND	Payment method not found	The payment_method code sent isn't correct.
402	400	INVOICE_ALREADY_USED	Invoice already used	The invoice_id sent has already been used
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 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
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
720	400	MISSING_CONFIGURATION	Missing configuration for merchant account	Please contact your AM/TAM