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

# Payment object

## Attributes

| Attribute             | Type                                      | Description                                                                                                                                                                                                     |
| :-------------------- | :---------------------------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id`                  | string                                    | The unique, permanent, Clearpay-generated Order ID.                                                                                                                                                             |
| `token`               | string                                    | Checkout token that was used to complete payment.                                                                                                                                                               |
| `status`              | string                                    | An order status of "APPROVED" or "DECLINED".                                                                                                                                                                    |
| `created`             | string                                    | The UTC timestamp of when the payment was completed, in [ISO 8601](http://www.iso.org/iso/home/standards/iso8601.htm) format.                                                                                   |
| `originalAmount`      | [Money](/money-object)                    | Total amount charged to the consumer for the order.                                                                                                                                                             |
| `openToCaptureAmount` | [Money](/money-object)                    | Remaining amount that can be captured. Will always be zero for [Immediate Payment Flow](/immediate-payment-flow) orders.                                                                                        |
| `paymentState`        | string                                    | Current state for capturing payments. Will be one of: "AUTH_APPROVED", "AUTH_DECLINED", "PARTIALLY_CAPTURED", "CAPTURED", "CAPTURE_DECLINED",  "VOIDED".                                                        |
| `merchantReference`   | string                                    | The merchant's order id/reference that this payment corresponds to.                                                                                                                                             |
| `refunds`             | [Refund](/refund-object)\[]               | An array of refunds. *Note: in response to a [Capture Full Payment](/immediate-payment-flow/capture-full-payment) call, this array will always be empty, since refunds cannot occur until payment is captured.* |
| `orderDetails`        | [Order Details](/order-details-object)    | The details of the order bound to the payment.                                                                                                                                                                  |
| `events`              | [Payment Event](/payment-event-object)\[] | One or more payment events that have occurred against the order.                                                                                                                                                |

## Example Payment object

```json
{
  "id" : "12345678",
  "token" : "ltqdpjhbqu3veqikk95g7p3fhvcchfvtlsiobah3u4l5nln8gii9",
  "status" : "APPROVED",
  "created" : "2019-01-01T00:00:00.000Z",
  "originalAmount" : {
    "amount" : "100.00",
    "currency" : "GBP"
  },
  "openToCaptureAmount" : {
    "amount" : "100.00",
    "currency" : "GBP"
  },
  "paymentState" : "AUTH_APPROVED",
  "merchantReference" : "merchantOrderId-1234",
  "refunds" : [
    ...
  ],
  "orderDetails" : {
    ...
  },
  "events" : [ {
    "id" : "1OUR16OTqL3DgJ3ELlwKowU9v6K",
    "created" : "2019-01-01T00:00:00.000Z",
    "expires" : "2019-01-01T00:00:00.000Z",
    "type" : "AUTH_APPROVED",
    "amount" : {
      "amount" : "100.00",
      "currency" : "GBP"
    }
  }, ... ]
}
```