A capture is used to request a debit to previously authorized transaction.
A capture request is performed using a previous payment authorization (AUTH) payment by referring its transactionID and sending a POST request over HTTPS to the /payments/{transactionID}/capture endpoint.
Capture can occur 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 /api/v1/payments/{transactionID}/capture
Request URL
https://spg.qly.site1.sibs.pt/api/v1/payments/{transactionID}/capture
Request headers
Authorization: Bearer 0276b80f950fb446c6addaccd121abfbbb.eyJlIjoiMTk4N (...)
X-IBM-Client-Id: 8247e05b-e64d-4948-843d-6e8b30224e39
Content-Type: application/json
Request body
{
"transactionID": "s2CB2CH3U91PdGDHsacJ",
"execution": {
"startTime": "2023-11-09T16:19:11.924Z",
"endTime": "2023-11-09T16:19:12.052Z"
},
"paymentStatus": "Timeout",
"returnStatus": {
"statusCode": "000",
"statusMsg": "Success",
"statusDescription": "Success"
}
"maxAmount": {
"value": 5.5,
"currency": "EUR"
},
"minAmount": {
"value": 5.5,
"currency": "EUR"
},
"entity": "24000"
}