Payout Services
Create Payout
In the payout service creation, all the required fields will be validated at first, after that, business validation rules will be run. The next table shows the information about the API.
post/v1/payment/payouts
Headers
Content-Typestring required
The Media type of the body of the request. Default value for payment provider protocol is application/json
Acceptstring required
Acceptable media type(s) for the response. Default value for payment provider protocol is application/json
Request body
Example request
{
"store": {
"code": "SBXSTORE"
},
"transaction": {
"reference_id": "REF0000001",
"business_id": "BIZ0000001",
"account": "SBX000PO",
"amount": {
"currency_code": "BRL"
}
},
"payment_method": {
"code": "PAYOUTS",
"recipient": {
"full_name": "Box Jhon",
"account": {
"type": "CC"
}
}
},
"notification_url": [
"https://www.providerApi.com/notificationPayouts"
],
"descriptor": "From Mike to Maria's birthday present"
}Response
Create payout response
Example response
{
"status": {
"error": {
"code": "G01",
"message": "Gateway, payment method not supported"
}
},
"store": {
"code": "SBXSTORE"
},
"descriptor": "From Mike to Maria's birthday present",
"transaction": {
"reference_id": "REF0000001",
"business_id": "BIZ0000001",
"account": "SBX000PO",
"amount": {
"currency": "btc"
}
},
"payment_method": {
"code": "PAYOUTS",
"recipient": {
"full_name": "Box Jhon",
"account": {
"type": "CC"
}
}
},
"payout_id": "5t1bc9001-6b5a-4f21-b5ee-fd32m4f436c6"
}