# The stripe payment object

A stripe payment object is returned as part of the response body of each successful list, retrieve, create or update API call to the `/api/stripe_payments` endpoint.

## Fields

| Field                              | Type      | Description                                                                                                                                                                                         |
| ---------------------------------- | --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **type**                           | `string`  | `stripe_payments`                                                                                                                                                                                   |
| **id**                             | `string`  | The stripe payment unique identifier                                                                                                                                                                |
| links.**self**                     | `string`  | The stripe payment endpoint URL                                                                                                                                                                     |
| attributes.**stripe\_id**          | `string`  | The Stripe payment intent ID. Required to identify a payment session on stripe.                                                                                                                     |
| attributes.**client\_secret**      | `string`  | The Stripe payment intent client secret. Required to create a charge through Stripe.js.                                                                                                             |
| attributes.**connected\_account**  | `string`  | The account (if any) for which the funds of the PaymentIntent are intended.                                                                                                                         |
| attributes.**charge\_id**          | `string`  | The Stripe charge ID. Identifies money movement upon the payment intent confirmation.                                                                                                               |
| attributes.**publishable\_key**    | `string`  | The Stripe publishable API key.                                                                                                                                                                     |
| attributes.**on\_behalf\_of**      | `string`  | The Stripe account ID that these funds are intended for.                                                                                                                                            |
| attributes.**transfer\_group**     | `string`  | A string that identifies the resulting payment as part of a group.                                                                                                                                  |
| attributes.**options**             | `object`  | Stripe payment options: 'customer', 'payment\_method', 'return\_url', etc. Check Stripe payment intent API for more details.                                                                        |
| attributes.**payment\_method**     | `object`  | Stripe 'payment\_method', set by webhook.                                                                                                                                                           |
| attributes.**mismatched\_amounts** | `boolean` | Indicates if the order current amount differs form the one of the created payment intent.                                                                                                           |
| attributes.**return\_url**         | `string`  | The URL to return to when a redirect payment is completed.                                                                                                                                          |
| attributes.**receipt\_email**      | `string`  | The email address to send the receipt to.                                                                                                                                                           |
| attributes.**\_update**            | `boolean` | Send this attribute if you want to update the created payment intent with fresh order data.                                                                                                         |
| attributes.**\_refresh**           | `boolean` | Send this attribute if you want to refresh the payment status, 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 Stripe 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: 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:

```
GET https://docs.commercelayer.io/core-api-reference/stripe_payments/object.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.