> For the complete documentation index, see [llms.txt](https://docs.commercelayer.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.commercelayer.io/core-api-reference/checkout_com_payments/object.md). # The checkout.com payment object A checkout.com payment object is returned as part of the response body of each successful list, retrieve, create or update API call to the `/api/checkout_com_payments` endpoint. ## Fields | Field | Type | Description | | ---------------------------------- | --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **type** | `string` | `checkout_com_payments` | | **id** | `string` | The checkout.com payment unique identifier | | links.**self** | `string` | The checkout.com payment endpoint URL | | attributes.**public\_key** | `string` | The Checkout.com publishable API key. | | attributes.**token** | `string` | The Checkout.com payment or digital wallet token. | | attributes.**payment\_session** | `object` | The session object which initializes payment. | | attributes.**success\_url** | `string` | The URL to redirect your customer upon 3DS succeeded authentication. | | attributes.**failure\_url** | `string` | The URL to redirect your customer upon 3DS failed authentication. | | attributes.**source\_id** | `string` | The payment source identifier that can be used for subsequent payments. | | attributes.**customer\_token** | `string` | The customer's unique identifier. This can be passed as a source when making a payment. | | attributes.**redirect\_uri** | `string` | The URI that the customer should be redirected to in order to complete the payment. | | attributes.**payment\_response** | `object` | The Checkout.com payment response, used to fetch internal data. | | attributes.**mismatched\_amounts** | `boolean` | Indicates if the order current amount differs form the one of the associated authorization. | | attributes.**\_authorize** | `boolean` | Send this attribute if you want to authorize the payment. | | attributes.**\_details** | `boolean` | Send this attribute if you want to send additional details the payment request (i.e. upon 3DS check). | | attributes.**\_refresh** | `boolean` | Send this attribute if you want to refresh all the pending transactions, can be used as webhooks fallback logic. | | attributes.**payment\_instrument** | `object` | Information about the payment instrument used in the transaction. | | attributes.**created\_at** | `string` | Time at which the resource was created. | | attributes.**updated\_at** | `string` | Time at which the resource was last updated. | | attributes.**reference** | `string` | A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever. | | attributes.**reference\_origin** | `string` | Any identifier of the third party system that defines the reference code. | | attributes.**metadata** | `object` | Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format. | | relationships.**order** | `object` | The order associated to the Checkout.com payment, that is set as its payment source. | | relationships.**payment\_gateway** | `object` | The associated payment gateway, inherited by the order payment\_method. | | relationships.**event\_stores** | `array` | The associated event stores. | | meta.**mode** | `string` | The resource environment (can be one of `test` or `live`) | --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.commercelayer.io/core-api-reference/checkout_com_payments/object.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.