Versions Compared

Key

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

6.1. Sending the request

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

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

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.

...