Reimburse PIX

This endpoint fully or partially reimburses (refunds) a deposit transaction.

Pre-conditions

  • The amount provided for refund must be equal to or less than the original transaction amount (for a partial refund).
  • At least one of the identifiers merchant_transaction_id, e2e_id, or transaction_id must be provided in the request.
  • If multiple identifiers are provided, they must all belong to the same transaction. If they belong to different transactions, the response will be 404 - Transaction not found.
  • Only successful deposits can be refunded.

Post-conditions

  • After the refund is completed, a webhook is sent with the update.
Body Params
string

Transaction identifier on the client side.

string

Official Bacen identifier for a Pix transaction.

string

Transaction identifier on the Paag side.

float

Amount to refund. If omitted, refunds the full transaction amount. Minimum: 0.01

Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json