> 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/2026-05/payment_sessions/object.md). # The payment session object A comprehensive list of the payment session resource's attributes and relationships A payment session object is returned as part of the response body of each successful list, retrieve, create or update API call to the `/api/2026-05/payment_sessions` endpoint. ## Fields | Field | Type | Description | | ------------------------------------------ | --------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **type** | `string` | `payment_sessions` | | **id** | `string` | The payment session unique identifier | | links.**self** | `string` | The payment session endpoint URL | | attributes.**status** | `string` | The payment session status. One of 'unpaid' (default), 'authorized', 'voided', 'invalidated', 'paid', 'partially\_paid', 'refunded', or 'partially\_refunded'. | | attributes.**amount\_cents** | `integer` | The payment session amount cents to collect, not updatable once the session is created. | | attributes.**amount\_float** | `float` | The payment session amount, float. | | attributes.**formatted\_amount** | `string` | The payment session amount, formatted. | | attributes.**capture\_balance\_cents** | `integer` | The payment session amount cents still to be captured. | | attributes.**capture\_balance\_float** | `float` | The payment session capture balance, float. | | attributes.**formatted\_capture\_balance** | `string` | The payment session capture balance, formatted. | | attributes.**refund\_balance\_cents** | `integer` | The payment session amount cents still to be refunded. | | attributes.**refund\_balance\_float** | `float` | The payment session refund balance, float. | | attributes.**formatted\_refund\_balance** | `string` | The payment session refund balance, formatted. | | attributes.**percentage\_amount\_cents** | `float` | The percentage of the order total (with taxes) covered by this payment session amount. | | attributes.**currency\_code** | `string` | The currency code for transactions. | | attributes.**gift\_card\_code** | `string` | The gift card code to be used in conjunction with a payment setting gift card. | | attributes.**token** | `string` | The unique token identifying the payment session. Can be specified for some payment gateway. Cannot be passed by sales channels. | | attributes.**options** | `object` | Options to use for the payment session, the passed values will be used to communicate with the payment gateway. Cannot be passed by sales channels. | | attributes.**vaulting** | `boolean` | Indicates that the payment instrument used for this session must be stored for future payments. Supported by Adyen, Checkout.com, PayPal, Stripe and external gateways with a token URL. | | attributes.**client\_data** | `object` | The data collected by the client mandatory to complete the payment process. | | attributes.**request\_data** | `object` | The data of the request sent to the payment gateway. | | attributes.**response\_data** | `object` | The payment gateway response data, used by client. | | attributes.**additional\_request\_data** | `object` | The data of the request sent to fetch extra information for the payment. | | attributes.**additional\_response\_data** | `object` | The response containing the extra information for the payment. | | attributes.**payment\_instrument** | `object` | Information about the payment instrument used in this session. | | attributes.**\_additional\_data** | `boolean` | Send this attribute if you want to request additional data for the payment. | | attributes.**\_refresh** | `boolean` | Send this attribute if you want to update the payment session with fresh data from the payment gateway. | | attributes.**\_internal\_version** | `string` | Send this attribute if you want to force a specific supported internal payload version for this request, overriding the payment setting's configured default. Only usable when the payment setting is internal\_versionable. | | attributes.**expires\_at** | `string` | Time at which this payment session will expire. Set automatically from the payment setting's own expiration window when not provided, and left blank only by the settings that have no gateway behind them. | | attributes.**balance\_exceeded\_at** | `string` | Time at which this payment session's authorization was detected to have exceeded the order's remaining balance, if it ever did. | | 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 associated order. | | relationships.**payment\_setting** | `object` | The associated payment setting. | | relationships.**payment\_wallet** | `object` | The associated payment wallet. | | relationships.**payment\_transactions** | `array` | The associated payment transactions. | | relationships.**payment\_authorization** | `object` | The associated payment authorization. | | relationships.**payment\_void** | `object` | The associated payment void. | | relationships.**payment\_captures** | `array` | The associated payment captures. | | relationships.**payment\_refunds** | `array` | The associated payment refunds. | | relationships.**attachments** | `array` | The associated attachments. | | relationships.**events** | `array` | The associated events. | | relationships.**event\_stores** | `array` | The associated event stores. | --- # 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/2026-05/payment_sessions/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.