/refund

Refund a settled or captured transaction.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
apiRequest
object
required
string
required
length ≤ 20

Office ID

string
required
length ≤ 40

Order No. (a.k.a Transaction Invoice No.)

string
length ≤ 50

Product Description (a.k.a. PNR)

string
length ≤ 20

Issuer approval code that obtained from authorization

originalRefundAmount
object

Refund amount in the base currency (used only for currency-conversion transactions).

refundAmount
object

Refund amount submitted in either the base currency (for standard transactions) or the converted/cardholder currency (for currency-conversion transactions). If originalRefundAmount is not provided, refundAmount is treated as the base currency. Required for non multi-currency transactions.

refundItems
array of objects
refundItems
refundToBankAccount
object

Bank account details. Required when PSP profile has IsBankDetailsRequired enabled. When required, all fields (clientEmail, bankId, accountName, accountNumber) must be provided.

refundNotificationURLs
object
localMakerChecker
object

Maker (requestor) for payment action and its Checker (approver). Checker can be the same person as Maker if there is no approval flow enforced.

pspMakerChecker
object

Maker (requestor) for payment action and its Checker (approver). Checker can be the same person as Maker if there is no approval flow enforced.

date-time

Custom expiry datetime for the refund payout link. If not provided, the system uses the company-configured default.

customFieldList
array of objects

Additonal auxiliary information of the payment transaction. Mostly for informative purpose alone.

customFieldList
string

Optional note for the refund request.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/jose