Skip to content

Create payout

API TEST CONSOLE

Test request

TEST ONLY

Configure parameters and send a request to the test environment

POST/trade/payout/create

Authentication

Not configured

The private key is used only in your browser to generate authorization. It is never sent or stored.

Request headers

Request body application/json

Response

Response
After you send the request, the status, duration, and JSON response appear here.

Authentication details remain only in this page's memory and are not written to local storage.

Copying cURL does not send a request

POST/trade/payout/create

Request headers

Common request headers.

Payment method values

payoutType
CVU
CBU

Request parameters

FieldTypeRequiredMaximum lengthDescription
merchantOrderNoStringYes32Merchant order number
transactionAmountStringYes20Payout amount, an integer or up to two decimal places
payoutTypeStringYes20Payout method
idTypeStringYes50ID type: DNI, CUIL, CUIT, PA
userIdCardStringYes50ID number. DNI contains 7–8 digits; CUIL contains 11 digits; CUIT contains 11 digits and starts with 2 or 3; PA contains at most 15 digits.
userNameStringYes64User name
userPhoneStringNo10User mobile number, 10 digits
userEmailStringNo50User email
bankCodeStringNo20Bank codes
bankNameStringNo-Bank name
bankAccountNoStringYes50CVU or CBU; both contain 22 digits.
descriptionStringNo100Description
payoutCallbackUrlStringNo200Payout callback URL

Request example

{
"merchantOrderNo": "PAYOUT202609170001",
"transactionAmount": "100.00",
"payoutType": "CVU",
"idType": "DNI",
"userIdCard": "12345678",
"userName": "TEST USER",
"userPhone": "1123456789",
"bankName": "Banco de Galicia y Buenos Aires S.A.U.",
"bankAccountNo": "1234567890123456789012"
}

Response parameters

FieldTypeRequiredMaximum lengthDescription
codeintYes-Status code; a value other than 200 indicates an error
dataObjectYes-Response body
data.merchantOrderNoStringYes32Merchant order number
data.tradeNoStringYes32Platform order number
data.transactionAmountStringYes-Payout amount
data.statusStringYes24Order status
data.payoutTypeStringYes24Payout method
msgStringNo-Error message
tidStringYes-Trace ID

Response example

{
"code": 200,
"data": {
"merchantOrderNo": "PAYOUT202609170001",
"tradeNo": "VF2405220001AR0000508467743993",
"transactionAmount": "100.00",
"status": "PAYING",
"payoutType": "CVU"
},
"msg": "success",
"tid": "747bbf80261844ed85b809212aab0d81"
}