API
Checking Raims account

Request a refund

Request a full or partial refund of a received Pix payment.

POSThttps://api.raims.com/v1/charges/{id}/refunds

Request a refund of a Pix payment received for the specified charge. The money returns to the account that made the payment. Send the amount you want to refund; the same request supports full and partial refunds.

In Production, accepting the request does not yet confirm the refund. In Sandbox, the simulation completes within the request. Keep the returned identifier and check the status of that same request.

See Refunds for the conditions of use and how to track the result.

Path Params

Identifier of the charge that received the Pix payment.

Up to 100 characters

Body Params

Amount requested for a refund, in Brazilian real cents. To refund the full amount, provide the remaining amount shown in the eligibility query.

Minimum 1

Refund request description. You can leave this field empty.

Up to 200 characters

Responses

For common errors, see HTTP response codes.