Refund Transaction

post

https://api.international.pagseguro.com/refunds

This request must be made in order to create a refund for a given transaction. This only creates the refund the processing and finishing of this refund is made by PagSeguro directly through the payment provider.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

transaction-id

integer

required

Transaction identifier in PagSeguro.

notify-url

url

required

URL used to notify the Merchant. This URL must bind ports 80 or 443.

amount

number

Amount to be refunded. If not sent, the refund will be processed for the entire value of the transaction. For partial refunds, the amount parameter must be sent.

test-mode

integer

enum

Parameter used to indicate that a transaction will be processed in test mode. Can be used the value 1 for sandbox or 0 for production environment. If not set assumes value 0.

Allowed:

reference

string

Merchant refund identifier. Limit of 64 characters.

Headers

string

enum

Defaults to application/vnd.boacompra.com.v2+json; charset=UTF-8

Generated from available response content types

Allowed:

Responses

201Success - The refund process will be started and the transaction will be set to processing refund status.

400Bad Request - Returns an error object with the description and an error code.