> 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_wallets/object.md). # The payment wallet object A comprehensive list of the payment wallet resource's attributes and relationships A payment wallet 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_wallets` endpoint. ## Fields | Field | Type | Description | | -------------------------------------- | --------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **type** | `string` | `payment_wallets` | | **id** | `string` | The payment wallet unique identifier | | links.**self** | `string` | The payment wallet endpoint URL | | attributes.**status** | `string` | The payment wallet status. One of 'pending' (default), 'requires\_action', 'processing', 'succeeded', or 'canceled'. | | attributes.**\_payment\_details** | `object` | Send this attribute on create if you want to send details for the payment to be stored. | | 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.**token** | `string` | The unique token identifying the payment wallet. | | attributes.**customer\_token** | `string` | The token identifying the customer on the gateway. | | attributes.**payment\_token** | `string` | The token identifying the payment method on the gateway. | | attributes.**options** | `object` | Options to use for the payment wallet, the passed values will be used to communicate with the payment gateway. Cannot be passed by sales channels. | | attributes.**payment\_data** | `object` | The data of the payment method related to this wallet. | | 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 successive payment workflows. | | attributes.**\_refresh** | `boolean` | Send this attribute if you want to update the payment wallet with fresh data from the payment gateway. | | attributes.**\_cancel** | `boolean` | Send this attribute if you want to cancel this payment wallet. | | attributes.**requires\_action\_at** | `string` | Time at which the payment wallet is marked as requires\_action. | | attributes.**processing\_at** | `string` | Time at which the payment wallet has been processed. | | attributes.**succeeded\_at** | `string` | Time at which the payment wallet is marked as succeeded. | | attributes.**canceled\_at** | `string` | Time at which the payment wallet has been cancelled. | | attributes.**expires\_at** | `string` | Time at which this payment wallet will expire. | | 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.**customer** | `object` | The associated customer. | | relationships.**payment\_setting** | `object` | The associated payment setting. | | relationships.**payment\_sessions** | `array` | The associated payment sessions. | | relationships.**order\_subscriptions** | `array` | The associated order subscriptions. | | 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_wallets/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.