Loading...
Our API gives you full control over the status of your transactions allowing you to capture, refund, or void them quickly and easily from your application. This guide goes through the potential lifecycle of a transaction and provides sample code for each request type.
For our first example, we process a Delayed Capture authorization. This will authorize the funds on the customer's card, but the transaction won't be placed in the settlement file until we capture it. The amount of time the funds can remain ring-fenced
on the customer's card may vary between different Issuers and Acquirers. The card schemes (Visa, Mastercard, and so on) also have their own rules around how long transactions can wait to be captured.
Funds may be lost if transactions are not captured in time. For information on capture limits, contact your account manager (or your acquirer).
If successfully authorized, the funds will now be ring-fenced on the customer's account. When you want to include the transaction in the next settlement file (also known as a batch) you can simply send a Capture (Settle) request. When the transaction is captured with the Acquirer, the funds are deducted from the customer's account and settled into the merchant's account.
To capture a transaction, you must provide the original Order ID and Payments Reference (pasref).You can capture a transaction for any amount up to 115% of the original value. However, in order to avail of the chargeback protection provided by 3D Secure, you must capture for the full amount. If you don't include an amount in your request, by default the full amount will be captured.
The amount of time it takes for the funds to settle into the merchant's account varies between different acquirers. It can be anything from 3-5 days and may also depend on the risk profile of the merchant.
Once a transaction is captured and the funds deducted from the customer's account, it is possible to refund the full or partial amount back to them without the need to obtain their card details again.
Merchants can process a refund for any amount up to 115% of the original transaction value. The Rebate Password must be hashed with the SHA-1 algorithm and added to the request before executing the transaction. Unlike Capture requests, the amount and currency must be specified in this request.
Sample request
Refunds can only be processed for a fixed amount of time after the original authorization. Different acquirers have different limits and this can range from 6 to 13 months. For information, contact your account manager (or your acquirer).
Before a transaction is captured, it is possible to Void an Authorization, Manual, Offline, Capture, Refund, or Credit request. If the transaction was already placed in the next settlement file (or batch), this will remove it. If using Delayed Capture, this will cancel the initial authorization. If the transaction was settled or batched, then it cannot be voided. This request requires the Order ID and payments reference (pasref) from the original transaction.