Create a refund

Create a refund

Body Params
string
required

Id of the transaction that will be refunded

string

Id of the refund on the client's system.

string
required

Status of the refund. It can be "pending", "invoiced" (if a credit note is invoiced), "voided" (in case the original invoice is voided) , "refunded" (no impact on taxes), or "rejected".

string
required

Type of the refund. It can be "refund", "chargeback", "adjustment".

float

It appears in RESPONSE. Amount to be refunded excluding taxes.

float

It appears in RESPONSE. Amount to be refunded including taxes.

string

The currency code of the refund amount. It can be the local currency or international_currency set for the transaction owner. Check Country Coverage and currencies. If not sent, will be the same currency used in the original transaction.

string

The exchange rate from the currency to the international currency set for the transaction owner.

string

Additional information regarding the refund.

string

Invoice (credit note) number of the refund.

date

Invoice date of the refund (UTC by default). Required when status is "invoiced".

items
array of objects

Items to be refunded.

items
Responses

Language
Credentials
OAuth2
LoadingLoading…
Response
Choose an example:
application/json