Issue a refund

post

https://gateway.pmnts-sandbox.io/v1.0/refunds

Issue a refund against a purchase or standalone

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Standalone Refunds

It is possible to issue a Standalone Refund (i.e. a refund that is not against an existing purchase), such as when refunding from a central account or some other kind of out-of-band refund scenario.

To issue a Standalone Refund, simply provide the card_token or provide card_number, card_holder and card_expiry in lieu of the transaction_id.

Support for Standalone Refunds may vary among banks, so please contact Fat Zebra support if you are unable to successfully issue a Standalone Refund.

Body Params

amount

int32

required

A positive integer representing how much to refund, in the smallest currency unit (e.g. 100 to charge $1.00, or 100 to Charge ¥100, a zero decimal currency).

reference

string

required

Merchant's reference for the refund. Must be unique per refund. Max length 255 characters.

transaction_id

string

ID of the original transaction to be refunded (XXX-P-YYYYYY). Required for an associated refund.

card_token

string

Token of the card being refunded. Required unless transaction_id or card details are provided.

card_number

string

Number of the card being refunded. Required unless transaction_id or card_token are provided.

card_expiry

string

Expiry of the card being refunded. Required unless transaction_id or card_token are provided.

card_holder

string

Name on the card being refunded. Required unless transaction_id or card_token are provided.

description

string

Description for the refund.

currency

string

Defaults to AUD

Currency being refunded. Ignored if transaction_id is present.

descriptor

string

Deprecated — use extra.descriptor instead. Description that appears on the customer's statement.

extra

object

Extended fields, only accepted for merchants configured to support them. See the Extra and Extended Fields guide.

Response

Standalone Refunds

200200