Refund a payment

Issues a full refund against a settled or approved payment. If attached to an invoice, the invoice status will return to an unpaid state.

POST

Headers

string

The Bearer token for authentication.

string

The user agent of the request. Must contain at least two identifiers separated by a space.

string

The content type of the request.

Parameters

string

The ID of the payment to refund.

Request Body

application/json
string

Reason for the refund.

Response Body

application/json
boolean

Indicates that the request was successful.

string

A descriptive message regarding the result.