Capture an authorised payment

POST

/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.

Request

Path Params

Header Params

Body Params application/json

Examples

Responses

🟢200OK - the request has succeeded.

application/json

Body

🟢201Created - the request has been fulfilled and has resulted in one or more new resources being created.

🟠400Bad Request - a problem reading or understanding the request.

🟠401Unauthorized - authentication required.

🟠403Forbidden - insufficient permissions to process the request.

🟠422Unprocessable Entity - a request validation error.

🔴500Internal Server Error - the server could not process the request.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/payments//captures' \
--header 'Content-Type: application/json' \
--data-raw '{
    "amount": {
        "currency": "str",
        "value": 0
    },
    "lineItems": [
        {
            "amountExcludingTax": 0,
            "amountIncludingTax": 0,
            "description": "string",
            "id": "string",
            "imageUrl": "string",
            "itemCategory": "string",
            "productUrl": "string",
            "quantity": 0,
            "taxAmount": 0,
            "taxPercentage": 0
        }
    ],
    "merchantAccount": "string",
    "reference": "string",
    "splits": [
        {
            "account": "string",
            "amount": {
                "currency": "str",
                "value": 0
            },
            "description": "string",
            "reference": "string",
            "type": "BalanceAccount"
        }
    ]
}'

Response Example

200 - Example 1

{
    "amount": {
        "currency": "str",
        "value": 0
    },
    "lineItems": [
        {
            "amountExcludingTax": 0,
            "amountIncludingTax": 0,
            "description": "string",
            "id": "string",
            "imageUrl": "string",
            "itemCategory": "string",
            "productUrl": "string",
            "quantity": 0,
            "taxAmount": 0,
            "taxPercentage": 0
        }
    ],
    "merchantAccount": "string",
    "paymentPspReference": "string",
    "pspReference": "string",
    "reference": "string",
    "splits": [
        {
            "account": "string",
            "amount": {
                "currency": "str",
                "value": 0
            },
            "description": "string",
            "reference": "string",
            "type": "BalanceAccount"
        }
    ],
    "status": "received"
}

Modified at 2023-08-15 09:16:27

Cancel an authorised payment

Refund a captured payment