Versions Compared

Version Old Version 8 New Version Current
Changes made by

PagBrasil

PagBrasil

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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

7.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

payout_date

When a payout is successfully registered in our database, PagBrasil's response has the following structure:

...

Anchor
5.e
5.e
e) To authenticate the legitimacy of the webhook, you may check the parameter secret and/or the parameter signature, which is a HMAC-MD5 hash based on the values of all elements (except the secret) and a key defined at the PagBrasil Dashboard, menu Account > Settings. The HMAC-MD5 source string is the concatenation of all the elements that are present in the structure and its total length.

...

f) After processing our webhook, your server needs to acknowledge that it has successfully received it by writing "Received successfully [timestamp]". If the webhook fails our system will e-mail your technical contact a warning notification (subject "Urgent: Error posting webhook"). If you activate the auto resend, our system will then try to resend failed webhook as follows:

  • The next 7 attempts will take place every 7 minutes.

  • The next 23 attempts will take place every 60 minutes. If the last attempt of sending the webhook fails, our system will e-mail another warning notification (subject "Urgent: Error posting webhook").

Please note that any webhook can be resent manually at any time at the PagBrasil Dashboard.