Overview
The APIs listed on this page allow the Merchant to fetch the details of a specific transaction that has been processed, and perform further actions on the transaction. These features can be used for tracking the transaction, to process new payments from existing customers, and to refund previous payments.
Features
Get a transaction
This allows you to fetch the details of a previously processed transaction. The details returned include the Customer name/email, amount, currency, status, payment source (i.e. Card, Open Banking or Direct Debit) and transaction id.
Advanced Features
These features are only available for card payments
Process a new payment
A card transaction can have a subsequent payment processed from it. This applies to all types of card transactions, such as SALE, PREAUTH or VERIFY. The new payment will re-use the details of the original transaction, including the Customer name and email, reference, currency, amount, and the card used. The amount and reference can be updated.
Cancel or Refund a payment
A successful card payment will initially have a status of captured. This means the payment has been authorised but not yet settled. At this stage, the payment can be cancelled.
When the transaction is settled (typically, this at midnight the following day), the transaction status will change to accepted. Once a payment status has updated to a status of accepted, it can no longer be cancelled. Instead, a refund can be actioned. In this scenario, it is possible to action a partial refund for some of the funds originally captured.
Capture a DC transaction early
A SALE transaction can be processed immediately, or with a delayed capture. The delayed capture feature allows you to authorise a payment, but delay the capture of the actual funds for a specific amount of days (up to a maximum of 30 days). A delayed capture transaction can be manually captured before the original scheduled date if needed. There is also the possibility to capture a partial amount (which will release the remaining funds).
Endpoints Overview
GET transactions/transaction_id: Retrieves the details of a transaction.
POST transactions/transaction_id/reruns: This allows you to process a new payment from an existing card transaction. This can be used to retry a failed payment, or to charge a new payment.
POST transactions/transaction_id/captures: This allows you to capture the full or partial funds of a delayed capture card payment earlier than intended.
POST transactions/transaction_id/cancels: This allows you to cancel a card payment that was processed before it gets settled.
POST transactions/transaction_id/refunds: This allows you to issue a full or partial refund for a card payment that was processed after it has been settled.