> This page is for version v1.
> 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                                 | Order token that was used to complete payment.                                                                                                                                                                                      |
| `status`            | string                                 | An order status of "APPROVED" or "DECLINED". *Note: in response to a [Capture Payment](/v-1/api-reference/online-api/payments/capture-payment) call, an object in this format will only be returned if the `status` is "APPROVED".* |
| `created`           | string                                 | The UTC timestamp of when the payment was completed, in [ISO 8601](http://www.iso.org/iso/home/standards/iso8601.htm) format.                                                                                                       |
| `totalAmount`       | [Money](/v-1/money-object)             | Total amount charged to the consumer for the order.                                                                                                                                                                                 |
| `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 Payment](/v-1/api-reference/online-api/payments/capture-payment) call, this array will always be empty, since refunds cannot occur before payment is captured.*               |
| `orderDetails`      | [Order Details](/order-details-object) | The order bound to the payment.                                                                                                                                                                                                     |
| `events`            | array                                  | This array is an obsolete field; it will always be empty.                                                                                                                                                                           |

## Example Payment object

**`UK`**

```json UK
{
  "id": "12345678",
  "token": "ltqdpjhbqu3veqikk95g7p3fhvcchfvtlsiobah3u4l5nln8gii9",
  "status": "APPROVED",
  "created": "2019-01-01T00:00:00.000Z",
  "totalAmount": {
    "amount": "29.99",
    "currency": "GBP"
  },
  "merchantReference": "merchantOrderId-1234",
  "refunds": [
    ...
  ],
  "orderDetails": {
    ...
  },
  "events": []
}
```