Submit a payout by PIX in Brazil.
This endpoint allows you to submit a payout by PIX in Brazil.
200: OK submit successfully 400: Bad Request order already existed 401: Unauthorized unauthorized 500: Internal Server Error system error 500: Internal Server Error balance insufficient 500: Internal Server Error fee not configured
Copy {
"code": 200,
"msg": "success",
"time": 1628580845,
"data": {
"id": "TS202108100734054iRiUZFPXfQM",
"custom_code": "custom_code9982674851738108",
"arrival_amount": "0.51",
"arrival_currency": "BRL",
"source_amount": "0.07",
"source_currency": "USD",
"status": "IN_PROCESSING"
}
}
Copy {
"code": 4001010,
"msg": "order already existed",
"time": 1628580940,
"data": {}
}
Copy {
"code" : 4004003 ,
"msg" : "permission denied" ,
"time" : 1637224716 ,
"data" : {}
}
Copy {
"code" : 5001000 ,
"msg" : "system error" ,
"time" : 1637224716 ,
"data" : {}
}
Copy // system error
{
"code" : 5001102 ,
"msg" : "balance insufficient" ,
"time" : 1637224716 ,
"data" : {
... ...
}
}
Copy {
"code" : 5001003 ,
"msg" : "fee not configured" ,
"time" : 1637224716 ,
"data" : {
... ...
}
}
Copy curl --location --request POST 'https://sandbox.transfersmile.com/api/payout' \
--header 'AppId: 94FAC**********************68548' \
--header 'Authorization: d6181db0d6548b94b162e75d095b59147172d914699f83b2bd17951a671b6302' \
--header 'Content-Type: application/json' \
--data-raw '{
* "name": "GUILHERME ****** SOUZA",
"phone": "",
"email": "payout@pagsmile.com",
* "amount": 150,
* "arrival_currency": "BRL", // fixed value: BRL
* "custom_code" : "custom_code_your_order_id",
* "document_id": "22*******99",
* "document_type": "CPF",
* "fee_bear": "merchant",
* "method": "PIX", // fixed value: PIX
* "notify_url": "https://notify.url",
* "account": "22*******99",
* "account_type": "CPF", // should be one of CPF CNPJ PHONE EMAIL EVP
* "source_currency": "BRL",
* "additional_remark": "pagsmile payout test remark",
* "country": "BRA" // fixed value: BRA
}'
Third-party CPF/CNPJ Validator