Capture an authorised payment
POST {{baseUrl}}/payments/:paymentPspReference/captures
Captures an authorised payment and returns a unique reference for this request. You get the outcome of the request asynchronously, in a CAPTURE webhook. You can capture either the full authorised amount or a part of the authorised amount. By default, any unclaimed amount after a partial capture gets cancelled. This does not apply if you enabled multiple partial captures on your account and the payment method supports multiple partial captures. Automatic capture is the default setting for most payment methods. In these cases, you don't need to make capture requests. However, making capture requests for payments that are captured automatically does not result in double charges. For more information, refer to Capture.
Body
PARAM
Key | Datatype | Required | Description |
HEADERS
Key | Datatype | Required | Description |
Content-Type
|
string | ||
Accept
|
string | ||
Idempotency-Key
|
null | A unique identifier for the message with a maximum of 64 characters (we recommend a UUID). |
RESPONSES
status Created
{
"merchantAccount": "YOUR_MERCHANT_ACCOUNT",
"paymentPspReference": "993617894903480A",
"reference": "YOUR_UNIQUE_REFERENCE",
"pspReference": "993617894906488A",
"status": "received",
"amount": {
"value": 2000,
"currency": "EUR"
},
"platformChargebackLogic": {
"behavior": "deductFromOneBalanceAccount",
"targetAccount": "BA00000000000000000000001",
"costAllocationAccount": "BA00000000000000000000001"
}
} |
ENDPOINTS