Capture

POST

/payment/<id>/capture

The capture method marks an Auth transaction for settlement, therefore the transaction ID is needed. This method also allows adjustments of the transaction amount.

If your request does not include the amount, our system will settle the full transaction with no changes in the amount field and vice versa.

You can perform multiple capture requests for a specific auth transaction until you reach the authorized amount. After that, you must submit a new authorization request to capture additional amounts.

Object

Fields	Description	Type	Filterable	Required	Readonly
id	Unique ID of the capture record	Integer	Yes	No	Yes
terminal	Terminal Object	Object	No	Yes	No
terminal.id	Dashboard Terminal ID	Integer	Yes	Yes	No
amount	Amount of the capture	Number	No	No	No
partial	Partial Object	Object	No	No	No
partial.total	Total payments	Integer	No	No	No
partial.sequence	Current payment sequence number	Integer	No	No	No
sendReceipt	Send receipt	Integer	No	No	No

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

Example

{
    "amount": "1.99",
    "partial": {
        "total": null,
        "sequence": null
    }
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/payment/<id>/capture' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "amount": "1.99",
    "partial": {
        "total": null,
        "sequence": null
    }
}'

Responses

🟢200Capture

application/json

Body

Example

{
    "amount": "1.99",
    "partial": {
        "total": null,
        "sequence": null
    }
}

Modified at 2025-08-09 05:39:41

Sale

Partial Capture