> This page is for version v2 (default).
> For other versions, use one of these documentation indexes:
> - v2 (default): https://developers.clearpay.co.uk/v-2/llms.txt
> - v1: https://developers.clearpay.co.uk/v-1/llms.txt

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://developers.clearpay.co.uk/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://developers.clearpay.co.uk/_mcp/server.

# Capture Full Payment [Express Checkout]

POST https://global-api-sandbox.afterpay.com/v2/payments/capture.
Content-Type: application/json

This endpoint performs a payment capture for the full value of the payment plan.

This operation is idempotent based on the token, which allows for the safe retry of requests, guaranteeing the payment operation is only performed once.

Since the idempotency of this endpoint is based on the token, the inclusion of a requestId is not required.

## Approved Response (201)

If payment is approved by Clearpay, returns a [Payment object](/payment-object) in response, with a `status` of "APPROVED".

## Declined Response (201)

If payment is declined by Clearpay, for example, if invalid card details were entered, returns a [Payment object](/payment-object) in response, with a `status` of "DECLINED".

Please advise the consumer to contact the Clearpay Customer Service team for more information.

## Connection Timeouts

| Timeout | Time (Seconds) |
| :------ | :------------- |
| Open    | 10             |
| Read    | 70             |

## Errors

In addition to the [PUT/POST Errors](/put-post-errors) applicable to all POST endpoints, the following errors are specific to Capture Full Payment:

| HTTP Status Code          | errorCode                          | Description                                                                            |
| :------------------------ | :--------------------------------- | :------------------------------------------------------------------------------------- |
| 402  Payment Required     | `invalid_token`                    | The checkout token is invalid, expired, or does not exist.                             |
| 412  Precondition Failed  | `invalid_order_transaction_status` | The Consumer has not confirmed their payment for the order associated with this token. |
| 422  Unprocessable Entity | `invalid_object`                   | The checkout token was missing or empty.                                               |

Reference: https://developers.clearpay.co.uk/api-reference/capture-full-payment-express-checkout-2

## Authentication

- `Authorization` header (basic auth, required) — Basic authentication of the form `Basic <base64(username:password)>`.

## Request

### Headers

- `Accept` (string, optional, default: application/json)

### Body (application/json)

This endpoint expects an object.

- `token` (string, required) — The token returned in the Create Checkout request.
- `amount` (V2PaymentsCapturePostRequestBodyContentApplicationJsonSchemaAmount, required) — Amount to be checked against the value in the create checkout request. If the amounts do not match, then the request will be rejected and an error specific to this scenario will be returned. This field is required for Express Checkout.
- `merchantReference` (string, optional) — The merchant’s order id/reference that this payment corresponds to. This will update any value previously provided in the Create Checkout request.
- `isCheckoutAdjusted` (boolean, optional) — The isCheckoutAdjusted field can be used to allow the order amount to be changed after the Express Checkout flow.
- `paymentScheduleChecksum` (string, optional) — A unique value representing the payment schedule that must be provided when there has been changes since the initial order creation (retrieved from checkout widget).
- `items` (list of string, optional)
- `shipping` (V2PaymentsCapturePostRequestBodyContentApplicationJsonSchemaShipping, optional) — The shipping address if it has changed since the initial order creation.

## Response

### 200

200

## Errors

### 400 Bad Request Error

400

## Types

### V2PaymentsCapturePostRequestBodyContentApplicationJsonSchemaAmount

Amount to be checked against the value in the create checkout request. If the amounts do not match, then the request will be rejected and an error specific to this scenario will be returned. This field is required for Express Checkout.

- `amount` (string, required, default: 0.00) — The amount as a string representation of a decimal number, rounded to 2 decimal places.
- `currency` (string, required, default: GBP) — The currency in [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) format.

### V2PaymentsCapturePostRequestBodyContentApplicationJsonSchemaShipping

The shipping address if it has changed since the initial order creation.

## Examples

**Request**

```json
{
  "token": "string",
  "amount": {
    "amount": "0.00",
    "currency": "GBP"
  }
}
```

**Response**

```json
{}
```

**SDK Code**

```python
import requests

url = "https://global-api-sandbox.afterpay.com/v2/payments/capture."

payload = {
    "token": "string",
    "amount": {
        "amount": "0.00",
        "currency": "GBP"
    }
}
headers = {
    "User-Agent": "User-Agent"
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers, auth=("<username>", "<password>"))

print(response.json())
```

```javascript
const url = 'https://global-api-sandbox.afterpay.com/v2/payments/capture.';
const credentials = btoa("<username>:<password>");

const options = {
  method: 'POST',
  headers: {
    'User-Agent': 'User-Agent',
    Authorization: `Basic ${credentials}`,
    'Content-Type': 'application/json'
  },
  body: '{"token":"string","amount":{"amount":"0.00","currency":"GBP"}}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://global-api-sandbox.afterpay.com/v2/payments/capture."

	payload := strings.NewReader("{\n  \"token\": \"string\",\n  \"amount\": {\n    \"amount\": \"0.00\",\n    \"currency\": \"GBP\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("User-Agent", "User-Agent")
	req.SetBasicAuth("<username>", "<password>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://global-api-sandbox.afterpay.com/v2/payments/capture.")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["User-Agent"] = 'User-Agent'
request.basic_auth("<username>", "<password>")
request["Content-Type"] = 'application/json'
request.body = "{\n  \"token\": \"string\",\n  \"amount\": {\n    \"amount\": \"0.00\",\n    \"currency\": \"GBP\"\n  }\n}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://global-api-sandbox.afterpay.com/v2/payments/capture.")
  .header("User-Agent", "User-Agent")
  .basicAuth("<username>", "<password>")
  .header("Content-Type", "application/json")
  .body("{\n  \"token\": \"string\",\n  \"amount\": {\n    \"amount\": \"0.00\",\n    \"currency\": \"GBP\"\n  }\n}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://global-api-sandbox.afterpay.com/v2/payments/capture.', [
  'body' => '{
  "token": "string",
  "amount": {
    "amount": "0.00",
    "currency": "GBP"
  }
}',
  'headers' => [
    'Content-Type' => 'application/json',
    'User-Agent' => 'User-Agent',
  ],
    'auth' => ['<username>', '<password>'],
]);

echo $response->getBody();
```

```csharp
using RestSharp;
using RestSharp.Authenticators;

var client = new RestClient("https://global-api-sandbox.afterpay.com/v2/payments/capture.");
client.Authenticator = new HttpBasicAuthenticator("<username>", "<password>");
var request = new RestRequest(Method.POST);
request.AddHeader("User-Agent", "User-Agent");

request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"token\": \"string\",\n  \"amount\": {\n    \"amount\": \"0.00\",\n    \"currency\": \"GBP\"\n  }\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let credentials = Data("<username>:<password>".utf8).base64EncodedString()

let headers = [
  "User-Agent": "User-Agent",
  "Authorization": "Basic \(credentials)",
  "Content-Type": "application/json"
]
let parameters = [
  "token": "string",
  "amount": [
    "amount": "0.00",
    "currency": "GBP"
  ]
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://global-api-sandbox.afterpay.com/v2/payments/capture.")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```