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…

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

Description that appears on the customer's statement.

Response

Language

Credentials

Basic

base64

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200