Versions Compared

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

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

...

Field

Description

Length

secret

Secret phrase as defined in the PagBrasil Dashboard

128

action

addpayout = Payout requested
successpayout = Payout completed
failpayout = Payout failed

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

57.2

date

Timestamp. Format: YYYY-MM-DD HH:MM:SS

19

signature

HMAC-MD5 hash that authenticates the webhook.
See note "e"   

32

...