This transaction type is available for: Cards.

A Capture is used to request clearing for previously authorized funds.

The Capture request is performed using a previous pre-authorisation (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

For the Capture request you should send:

Capture description:

Capture request:

Capture request example:

{
 "merchant": {
 "terminalId": {{TerminalID}},
 "channel": "web",
 "merchantTransactionId": "BO_Order Id: "
 },
 "transaction": {
 "transactionTimestamp": "{{trxDatetime}}",
 "description": "Transaction short description",
 "amount": {
 "value": 1,
 "currency": "PLN"
 },
 "originalTransaction": {
 "id": "{{originalTransactionId}}"
 }
 }
}

The response below, will include the transaction ID, which you can use to check the status.

{
 "merchant": {
 "terminalId": "101776",
 "merchantTransactionId": "BO_Order Id: ",
 "merchantTransactionTimestamp": "2023-06-20T11:15:57.040Z"
 },
 "transactionTimestamp": "2023-06-20T11:16:14.988Z",
 "amount": {
 "value": "1",
 "currency": "PLN"
 },
 "transactionID": "RW5vBMHj4RhQWFRc0GvS",
 "execution": {
 "startTime": "2023-06-20T11:15:57.206Z",
 "endTime": "2023-06-20T11:16:15.100Z"
 },
 "paymentStatus": "Success",
 "returnStatus": {
 "statusCode": "000",
 "statusMsg": "Success",
 "statusDescription": "Success."
 }
}

Afterwards, once the payment has been processed, you can check the status of your transaction making a GET request.

The Authorisation HTTP header is set to the Bearer token as it was used in the initial Checkout.

Request URL:

https://stargate-cer.qly.site1.sibs.pt/api/v1/payments/{transactionID}/status

Request Headers:

Autorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6I (...)
X-IBM-Client-Id: b4480347-9fc8-4790-b359-100a99c60ea3
Content-Type: application/json

A successful technical response comprises of an HTTP-200 status and a returnStatus.statusCode=”000″.

Here are some examples of the possible result codes: