Manage Payments
The Backoffice APIs allows merchants to perform different Backoffice operations over their transactions, for example a capture, refund, cancellation and recurring transaction.
Capture
A capture is used to request clearing for previously authorized funds.
A capture request is performed using a previous preauthorisation (AUTH) payment by referencing its transactionID and sending a POST request over HTTPS to the /payments/{transactionID}/capture endpoint.
Captures can happen in different ways:
- Full, capture the full amount authorized and finish the purchase
- Partial, split the capture over one or several capture requests, up to the total amount authorized
POST https://stargate-cer.qly.site1.sibs.pt/api/v1/payments/{transactionID}/capture
Request Headers:
Autorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6I (…)
X-IBM-Client-Id: b4480347-9fc8-4790-b359-100a99c60ea3
Content-Type: application/json
Cancellation
A cancellation is performed against a previous payment authorisation (AUTH), by referencing its transactionID and sending a POST request over HTTPS to the /payments/{transactionID}/cancellation endpoint.
When canceling a payment and if sent within the time-frame the authorisation is not captured yet, the cancellation causes an authorisation reversal request to be sent to the card issuer to clear the funds held against the authorisation.
It can be a Full cancellation when the total amount of the authorisation is cancelled by the merchant , or a Partial, when a subtotal of the total authorisation is cancelled by the merchant
POST https://stargate-cer.qly.site1.sibs.pt/api/v1/payments/{transactionID}/cancellation
Autorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6I (…)
X-IBM-Client-Id: b4480347-9fc8-4790-b359-100a99c60ea3
Content-Type: application/json
Refund
The purpose of this operation is to refund the amount of a previous payment, crediting the cardholder account and debiting the Merchant account.
A refund can be:
- A refund is performed against a previous payment, referencing its transactionID by sending a POST request over HTTPS to the /payments/{transactionID}/refund endpoint.
- A refund can be performed against purchase (PURS) or captured preauthorisation (AUTH -> Capture) payment types.
It can be a Full refund when the total amount of the purchase is refunded to the cardholder, or a Partial, when a subtotal of the total purchase is refunded to the cardholder
POST https://stargate-cer.qly.site1.sibs.pt/api/v1/payments/{transactionID}/refund
Autorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6I (…)
X-IBM-Client-Id: b4480347-9fc8-4790-b359-100a99c60ea3
Content-Type: application/json
Recurring
The purpose of this operation is to allow the merchant to charge a recurrent service, in the first stage the cardholder requests the payment as an Initial recurring and authorize the merchant to do future debits (following recurring) accordingly with the service
- Initial Recurring – Needed to register as initial recurring
- Following Recurring – Triggers following payments
