Cashout Creation Endpoint

Cashout Request

POST https://api-stg.tupayonline.com/v3/cashout

This endpoint allows you to generate cashout requests

Headers

Name	Type	Description
Content-Type*	string	application/json
Payload-Signature*	string	Control signature

Request Body

Name	Type	Description
login*	string	Your Tupay CASHOUTS API login key
pass*	string	Your Tupay CASHOUTS API pass key
external_id*	string	Unique cashout ID on the merchant end
country*	string	Country of the cashout
amount*	number	Amount of the cashout
currency	string	Currency in which the amount was specified
document_id*	string	Document ID of the beneficiary
document_type	string	Document type of the ID specified
beneficiary_name*	string	Beneficiary's name
beneficiary_lastname	string	Beneficiary's last name
bank_account	string	Beneficiary's bank account
account_type	string	Beneficiary's account type
notification_url*	string	URL where the notifications will be sent
comments	string	Commentaries about the cashout

200 Cashout request successfully created.

{
    "cashout_id": "8405147"
}

401 The credentials specified are incorrect.

{
    "code": 401,
    "message": "Invalid credentials."
}

412 Error in the data validation.

{
    "code": 303,
    "message": "Invalid bank code"
}

{
    "code": 300,
    "message": "bank_account: must not be null; Invalid Bank account"
}

Request Example

{
    "login": "xxxxxxx",
    "pass": "xxxxxxx",
    "external_id": "30000000001",
    "country": "PE",
    "currency": "PEN",
    "amount": 100,
    "document_id": "848392783",
    "document_type": "CE",
    "bank_account": "00219300153895206813",
    "account_type": "C",
    "beneficiary_name": "User",
    "beneficiary_lastname": "Test",
    "notification_url": "https://webhook.site/url",
    "type": "json"
}

Request Fields Description

Field	Format	Description	Validations
login	string (max length: 32)	Your Tupay CASHOUTS API Key, found on the Merchant Panel by going to: Settings -> API Access. Notice there are specific Cashout credentials
pass	string (max length: 32)	Your Tupay CASHOUTS API Passphrase, found on the Merchant Panel by going to: Settings -> API Access. Notice there are specific Cashout credentials
external_id	string (max length: 100)	Unique cashout ID on the merchant end
country	string (length: 2)	Country code for the cashout in ISO 3166-1 alpha-2 code format	"PE" (Peru)
amount	Big Decimal (up to 2 decimals)	Cashout amount on the currency specified	Valid number
currency	string (length: 3)	Currency code of the amount in ISO 4217 format	PEN / USD
document_id	string (max length: 40)	Beneficiary’s personal identification number	8 to 12 digits
document_type	string (maxLength: 15)	Beneficiary’s personal identification number type	CE/CPP, DNI, RUC, or PASS
beneficiary_name	string (max length: 100)	Beneficiary's name	String of up to 100 characters
beneficiary_lastname	string (max length: 100)	Beneficiary's last name	String of up to 100 characters
bank_account	string (max length: 30)	Beneficiary's bank account number	CCI - Código de Cuenta Interbancaria - 20 digits
account_type	string (max length: 1)	Type of account	"C" (Checking) "S" (Savings)
notification_url	string (max length: 300)	To be provided if the notification URL is different from the notification URL defined on the Merchant Panel	Valid URL over HTTPS
comments	string (max length: 200)	A commentary for this cashout	String of up to 200 characters