Refund a Payment

Body Params

paymentRequest

string

required

The ID of the PaymentReques to be refunded.

amount

float

Defaults to 100

The amount to refund if issuing a partial refund for the payment request.

reason

string

enum

The reason for the refund.

Allowed:

reasonNotes

string

The notes for the reason provided.

Headers

idempotencyKey

string

A unique identifier to ensure the same operation isn't processed multiple times, preventing duplicate transactions.

onBehalfOf

string

Specifies the account for which the refund is intended. This is used for scenarios where one partner processes payments on behalf of another partner, such as in PayFac or related partner relationships.

201201

400400

401401