Versions Compared

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

customer_bank

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

Yes

3

customer_branch

Branch number (agência).

Yes

12

customer_account

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

Yes

12

Notes:

a) The merchant needs to ask the end customer for their bank details and submit these to us using the parameters customer_bank (número do banco), customer_branch (agência) and customer_account (conta corrente). Please note that there is no other way to obtain the bank details, as banks don't disclose the customer's bank account information.

...

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

...

Anchor
6.1.c
6.1.c
e) Please find the bank numbers here (column "Número Código").

6.2. Receiving the refund confirmation

Refunds are processed within one business day. 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 "B". This value specifies that the data being posted is the response to a Boleto Bancário refund request (either for a traditional Boleto Bancário or a Boleto Flash®).

1

order

Order number

64

amount_brl

Amount in Brazilian Real

5.2

amount_refunded

Amount requested to be refunded (Brazilian Real)

5.2

payment_status

P = Refund Processed See note "a"   
J = Refund rejected See note "b"   

1

signature

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

32

Anchor
6.1.a
6.1.a
a) The payment status is returned as "P" (Refund Processed) when the refund request was submitted to the bank using the account information provided by the end customer.

...