Backoffice Operations

Backoffice Operations

You can perform different types of backoffice operations using our server-to-server REST API.

Note: Backoffice operations can be performed against initial payments that were generated using COPYandPAY or server-to-server. The referencedPaymentId is the value return in the id JSON field.

Capture an authorization

A capture is used to request clearing for previously authorized funds.  A capture request is performed against a previous preauthorization (PA) payment by referencing its payment.id and sending a POST request over HTTPS to the /payments/{id} endpoint.  Captures can be for full or partial amounts and multiple capture requests against the same PA are allowed.

Refund a payment

A refund is performed against a previous payment, referencing its payment.id by sending a POST request over HTTPS to the /payments/{id} endpoint. A refund can be performed against debit (DB) or captured preauthorization (PA->CP) payment types. Where supported, the amount field can be used to process a partial or full amount.

Reverse a payment

A reversal is performed against a previous payment, referencing its payment.id by sending a POST request over HTTPS to the /payments/{id} endpoint. A reversal can be sent against debit (DB) or preauthorization (PA) payment types. When reversing a card payment and if sent within 72 hours of the original request, a reversal causes an authorization reversal request to be sent the card issuer to clear the funds held against the authorization.

NOTE: A reversal can only reverse the full transaction and does not require the amount or currency to be sent i.e. a partial reversal is not possible.

Rebill a payment

A rebill is performed against a previous payment, referencing its payment.id by sending a POST request over HTTPS to the /payments/{id} endpoint. A rebill can be sent against a prior debit (DB payment type) transaction. The rebill transaction payment type must be RB (paymentType=RB).


Try it out


Credit (stand-alone refund)

A credit is a independent transaction that results in a refund. The difference is that the refund is not associated with a previous transaction and so requires the full payment details to be included in the request.


Try it out