...
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 "addpayee". | Yes | 11 |
payee_name | Payee's full name if an individual, or "razão social" if the payee is a company. See note "c" | Yes | 128 |
payee_taxid | CPF if an individual, or CNPJ if the payee is a company. See note "d" | Yes | 14 |
payee_bank | Identification of the bank in the Brazilian Central Bank. See note "e" | Yes | 43 |
payee_branch | Payee's account branch number (do not include the verification digit; for example: 1234). | Yes | 12 |
payee_account | Payee's account number (must include the hyphen and the verification digit; for example: 1234568-0). | Yes | 12 |
payee_account_type | Type of the payee's account. "1" = Checking (conta corrente) or "2" = Savings (poupança). | Yes | 1 |
payee_document_link | URL where the payee's scanned documents are stored. See note "f" | YesNo | 250 |
payee_description | Description to be registered as the product name when a payout is sent. | Yes | 250 |
payee_email | Payee's e-mail address | Yes | 128 |
payee_phone | Payee's phone number (including the 2-digit area code) | Yes | 40 |
payee_street | Payee's street address | Yes | 200 |
payee_zip | Payee's postal code (in Brazil called CEP). Only digits, do not include the dash. | Yes | 8 |
payee_city | Payee's city | Yes | 40 |
payee_state | Payee's state (official abbreviation). See note "j" | Yes | 2 |
...
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 "updatepayee". | Yes | 11 |
payee_name | Payee's full name if an individual, or "razão social" if the payee is a company. See note "c" | No | 128 |
payee_taxid | CPF/CNPJ of the payee being updated. Must be the same as the payee_taxid submitted on "addpayee" action. See note "d" | Yes | 14 |
payee_bank | Identification of the bank in the Brazilian Central Bank. See note "e" | No | 43 |
payee_branch | Payee's account branch number (do not include the verification digit; for example: 1234). | No | 12 |
payee_account | Payee's account number (must include the hyphen and the verification digit; for example: 1234568-0). | No | 12 |
payee_account_type | Type of the payee's account. "1" = Checking (conta corrente) or "2" = Savings (poupança). | No | 1 |
payee_document_link | URL where the payee's scanned documents are stored. See note "f" | No | 250 |
payee_description | Description to be registered as the product name when a payout is sent. | No | 250 |
payee_email | Payee's e-mail address | No | 128 |
payee_phone | Payee's phone number (including the 2-digit area code) | No | 40 |
payee_street | Payee's street address | No | 200 |
payee_zip | Payee's postal code (in Brazil called CEP). Only digits, do not include the dash. | No | 8 |
payee_city | Payee's city | No | 40 |
payee_state | Payee's state (official abbreviation). See note "j" | No | 2 |
...
PagBrasil will send a webhook to your server whenever a payee's status is changed. See note "g"
In the case where the payee is approved directly, the webhook will not be sent since the payee's status will start as approved and will not be changed.
You need to login to the PagBrasil Dashboard and specify the URL you want PagBrasil to send the webhook. By default we only allow outgoing connections to HTTPS URLs at standard port 443. If you plan to use a different port number in the webhook's URL please contact us requesting an exception.
...
Due to validation security reasons, this field cannot be changed after insertion. In order to change this information you must delete the old payee and then add a new one.
...
| Anchor | ||||
|---|---|---|---|---|
|
...
| Anchor | ||||
|---|---|---|---|---|
|
...