API Reference

Refund captured payment

post
https://sandbox-api.pagaleve.io/v1/payments//refund

This endpoint is for refunding a captured payment. It supports full, partial, and multiple refunds up to the total captured amount.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Payment Id

Body Params
number
required

Amount to be refunded in cents

string

Description field to add observations about the refund

string

Refund ID from the merchant

string
enum

Refund reason

Allowed:
recipients
array of objects

Merchants if the operation is for a marketplace type order.

recipients
Headers
string

The API supports idempotency for security in request retries, thus avoiding executing the same operation twice.

string

When a holding company queries subsidiary data, this field is required and must contain the subsidiary ID.

Responses

Updated 12 months ago

Did this page help you?
Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 12 months ago

Did this page help you?