Pay Out - Brazil
Developing
Develop Env
https://api.v2.stg.paypaga.com
Develop Env
https://api.v2.stg.paypaga.com
POST
https://api.v2.stg.paypaga.com
Identification
| Identification type | Description | Validation |
|---|---|---|
| CPF | Cadastro de Pessoas Físicas | ^\d{11}$ |
Request
Header Params
Body Params application/json
Responses
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.v2.stg.paypaga.com/payout' \
--header 'Authorization;' \
--header 'Content-Type: application/json' \
--data-raw '{
"country_code": "BR",
"currency": "BRL",
"payment_method_code": "BNKTR",
"transaction": {
"beneficiary": {
"beneficiary_name": "Pedro Lopes",
"beneficiary_type": "INDIVIDUAL",
"beneficiary_id": "43000000000",
"beneficiary_id_type": "CPF",
"beneficiary_pix_key": "43000000000"
},
"transaction_data": {
"payout_concept": "brazil payout transaction",
"merchant_transaction_reference": "10000",
"transaction_total": 100.25
}
}
}'Response Response Example
{
"datetime": "2024-04-09 18:47:07.960978",
"message": "Payment processing initiated",
"details": {
"result": "success",
"transaction_processed": {
"transaction_id": "20240409-1847-0783-90cc-133c988ef5c6",
"merchant_transaction_reference": "150267"
}
},
"version": "0.1"
}