...
Request parameters (see notes below):
5.1. Sending a payout
Field | Description | Required | Length |
|---|---|---|---|
secret | Secret phrase as defined in the PagBrasil Dashboard | Yes | 128 |
pbtoken | Token assigned to your merchant account. Your token is displayed at the PagBrasil Dashboard, menu Account > Settings. | Yes | 32 |
action | Action to be performed. Value "addpayout". | Yes | 9 |
payee_id | CPF/CNPJ of the recipient of the payout amount (payee_taxid submitted on "addpayee" action). When transferring between PagBrasil merchant accounts, please use the pbtoken assigned to the recipient's account. | Yes | 32 |
payout_amount | Amount to be paid to recipient in Brazilian Real. Format: 99999.99 | Yes | 5.2 |
payout_description | Description to be saved as the product name preceded by "Payout - " (e.g. considering payout_description = "XYZ", product name is set as "Payout - XYZ"). When not informed, product name is simply set as "Payout". | No | 254 |
When a payout is successfully registered in our database, PagBrasil's response has the following structure:
Field | Description | Length |
|---|---|---|
action | Value "addpayout". | 9 |
success | Value "true" indicates the payout was successfully included in our database. | 5 |
id | Unique number that identifies the payout. | Unlimited |
When a payout failed to be registered in our database, PagBrasil's response has the following structure:
Field | Description | Length |
|---|---|---|
action | Value "addpayout". | 9 |
success | Value "false" indicates the payout failed to be included in our database. | 5 |
error_message | Error message(s), separated by semicolons. | Unlimited |
internal_message | PagBrasil's internal use information. | Unlimited |
5.2. Receiving the webhook
...
Webhook content has the following structure:
Field | Description | Length |
|---|---|---|
secret | Secret phrase as defined in the PagBrasil Dashboard | 128 |
action | addpayout = Payout requested | 13 |
taxid | CPF/CNPJ of the recipient of the payout amount. | 14 |
id | Unique number that identifies the payout. | Unlimited |
amount | Payout amount in Brazilian Real | 5.2 |
date | Timestamp. Format: YYYY-MM-DD HH:MM:SS | 19 |
signature | HMAC-MD5 hash that authenticates the webhook. | 32 |
Notes:
a) All fields are required except when noted otherwise.
...