Versions Compared

Version Old Version 5 New Version Current
Changes made by

PagBrasil

PagBrasil

Saved on

Key

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

...

Please note that this URL shall only be used for integration and testing procedures. Once the Payment Service Agreement is signed, you will receive the production environment's URL when you request your account to go live.

Request parameters:

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

order

Order number

Yes

64

amount_refunded

Amount requested to be refunded (Brazilian Real)

Yes

5

7.2

customer_bank

Only used when a refund is rejected. See note 6.2, item "c".

No

40

customer_branch

Only used when a refund is rejected. See note 6.2, item "c".

No

12

customer_account

Only used when a refund is rejected. See note 6.2, item "c".

No

12

Note: A successful response for the refund request will be "Refund request received".

...

You need to login to the PagBrasil Dashboard and specify the URL you want PagBrasil to notify you when the refund is processed.

PagBrasil's POST:

Field

Description

Length

secret

Secret phrase as defined in the PagBrasil Dashboard

128

payment_method

Value "X". This value specifies that the data being posted is the response to a PagBrasil Pix refund request.

1

order

Order number

64

amount_brl

Amount in Brazilian Real

5

7.2

amount_refunded

Amount refunded (Brazilian Real)

5

7.2

payment_status

C = Chargeback See note "a"   
P = Refund Processed See note "b"   
J = Refund rejected See note "c"   

1

signature

HMAC-MD5 hash that authenticates the IPN.
See note "d"   

32

Notes:

Anchor
#PixNote62A#PixNote62A6.2.a
6.2.a
a) The payment status is returned as "C" (Chargeback) when a previously authorized transaction is reversed by the wallet/bank. In addition our system will send a chargeback notification to the e-mail address you registered at the PagBrasil Dashboard.

...

Anchor
#PixNote62B#PixNote62B6.2.b
6.2.b
b) The payment status is returned as "P" (Refund Processed) when the refund request was accepted by the wallet/bank.

...

Anchor
#PixNote62C#PixNote62C6.2.c
6.2.c
c) The payment status is returned as "J" (Refund rejected) when the refund request was not accepted by the wallet/bank. In this case our system will also send a notification to the email address you registered at the PagBrasil Dashboard, and you may refund the transaction through PagBrasil via bank transfer, by including the following parameters when requesting the refund via API: /div

customer_bank = Customer's bank number (número do banco). Please find the bank numbers here (column "Número Código").
customer_branch = Branch number (agência).
customer_account = Account number (conta corrente). Must include the hyphen and the verification digit; for example: "12345-6".

...

IMPORTANT: The bank account holder must be the customer, and not a third-party. The fee for this type of refund is the same as that applied for a boleto bancário refund. Please refer to your proposal or contract for further details.

...

Anchor
#PixNote62D#PixNote62D6.2.d
6.2.d
d) To authenticate the legitimacy of the IPN, you may check the parameter secret and/or the parameter signature, which is a HMAC-MD5 hash based on three parameters and a key defined at the PagBrasil Dashboard, menu Account > Settings. The HMAC-MD5 source string is the concatenation of the values of the parameters order, amount_brl and payment_status and the total length for these three parameters. For example, if parameter order="1234567890", amount_brl="39.50" and payment_status="P", the parameter signature would be "3093a7dffa0c04e74e827d1b52ef514e".

...