Versions Compared

Old Version 3

changes.mady.by.user PagBrasil

Saved on

compared with

New Version 4

changes.mady.by.user PagBrasil

Saved on

Key

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

...

Your POST must be sent to https://sandbox.pagbrasil.com/api/order/refund setting the content-type of the request header and body as "x-www-form-urlencoded".

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

suspicious

Value "1" indicates that you are refunding the order because you suspect that it is a fraudulent order. That feeds our PagShield fraud prevention service database. Otherwise, set this parameter as "0" (or blank).

No

1

customer_bank

Customer's bank number (número do banco). See note "b"   

No

3

customer_branch

Branch number (agência).

No

12

customer_account

Account number (conta corrente). Must include the hyphen and the verification digit; for example: "12345678-0".

No

12

Notes:

a) A successful response for the refund request will be "Refund request received".

b) Please find the bank numbers here (column "Número Código").

6.2. Receiving the refund confirmation

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

C = Credit card
D = Debit card
B = Boleto Bancário or Boleto Flash®
P = PEC Flash®
X = PagBrasil Pix

1

order

Order number

64

amount_brl

Amount in Brazilian Real

5.2

amount_refunded

Amount refunded (Brazilian Real)

5.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
6.2.a
6.2.a
a) The payment status is returned as "C" (Chargeback) when a previously authorized transaction is reversed by the credit card issuer. In addition our system will send a chargeback notification to the e-mail address you registered at the PagBrasil Dashboard.

...

Anchor
6.2.b
6.2.b
b) The payment status is returned as "P" (Refund Processed) when the refund request was accepted by the credit card acquirer. The delay between the refund being accepted and the customer seeing the credit on their statement depends on the credit card issuer. If it is a refund via bank transfer, the status "P" indicates the refund request was submitted to the bank using the account information provided by the end customer. Please note that the Refund Processed status doesn't necessarily mean that the customer has received the credit, as the money can later be returned by the recipient's bank if the account information turns out to be incorrect.

...

Anchor
6.2.c
6.2.c
c) The payment status is returned as "J" (Refund rejected) when the refund request was not accepted by the credit card acquirer. This usually happens when the order is older than 300 days. 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:

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

...