Request / Response Schema
Use these resources to write your API requests and interpret the responses returned:
Processing transactions
AUTH
Authorisation
This request seeks authorisation for the transaction from the banks. Following successful authorisation, funds are reserved against the customer's account until settlement.
REFUND
Refund
This request seeks authorisation for a refund to a previously-settled transaction.
Payouts
Payouts
Payouts are used to credit funds to another bank account. Common use cases of this include paying out an insurance claim to a customer or allowing customers to withdraw funds from their account with you.
ACCOUNTCHECK
Account Check
This request can be used for tokenization (Credentials on File) or for checking the validity of the customer's payment details.
Managing transactions
TRANSACTIONQUERY
Transaction Query
This request performs a query on a previously-processed request. The response returns useful information, such as the status of the transaction and customer contact information.
TRANSACTIONUPDATE
Transaction Update
This request is used to update a previously-processed request, e.g. updating the final settle amount or settle date.