Sign in

v1

latestOpenAPI 3.0.3MIT2026-07-2428350487.0 KB
Payments

Capture a payment

post/payments/{paymentId}/capture

Path parameters

paymentIdstring required

The unique identifier for the payment.

This can be sourced from the paymentId field in the response we sent to you when creating the payment or payout.

Request body

amountinteger

Amount to be captured on a payment that has been previously authorized but not settled. In the lowest denomination of the currency of the payment. This means that 1234 in GBP represents £12.34.

Example request

{
  "amount": 1234
}

Response

Transaction captured successfully.

codestring

Response Code signifying the outcome of the request.

messagestring

A description of the outcome of the request.

idstring

The ID of this request. If you can include these when querying the outcome of individual requests, we can track down the root cause faster.

Example response

{
  "code": "1000",
  "id": "463ac35c9f6413ad48485a3953bb6124",
  "psp": {
    "name": "Checkout.com",
    "transactionId": "6418da68-0b3d-4409-ab14-1ceb752b0b1f",
    "switchAccountId": "switch-account-123",
    "provisionedUserId": "Vx0H4pdAtPCz",
    "additionalInfo": {
      "customerFirstName": "John",
      "customerLastName": "Smith",
      "customerDateOfBirth": "2000-01-01",
      "customerIpAddress": "123.100.100.200",
      "customerId": "de5d7b4a-9410-40e1-85fd-8ceee23c9fd0",
      "paysafecardCustomerId": "151743187547"
    },
    "rawPspResponses": [
      {
        "httpStatusCode": 200,
        "pspName": "Checkout.com",
        "headers": {
          "content-type": [
            "application/json"
          ]
        }
      }
    ]
  }
}