# The stripe gateway object

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

## Fields

| Field                                    | Type      | Description                                                                                                                                                                                         |
| ---------------------------------------- | --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **type**                                 | `string`  | `stripe_gateways`                                                                                                                                                                                   |
| **id**                                   | `string`  | The stripe gateway unique identifier                                                                                                                                                                |
| links.**self**                           | `string`  | The stripe gateway endpoint URL                                                                                                                                                                     |
| attributes.**name**                      | `string`  | The payment gateway's internal name.                                                                                                                                                                |
| attributes.**force\_payments**           | `boolean` |                                                                                                                                                                                                     |
| attributes.**credential\_keys**          | `object`  | The payment gateway's API credential keys last digits.                                                                                                                                              |
| attributes.**\_disable**                 | `boolean` | Send this attribute if you want to mark this resource as disabled.                                                                                                                                  |
| attributes.**\_enable**                  | `boolean` | Send this attribute if you want to mark this resource as enabled.                                                                                                                                   |
| attributes.**disabled\_at**              | `string`  | Time at which this resource was disabled.                                                                                                                                                           |
| 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.                                        |
| attributes.**\_check**                   | `boolean` | Send this attribute if you want to check the credentials against the payment gateway's APIs.                                                                                                        |
| attributes.**login**                     | `string`  | The gateway login.                                                                                                                                                                                  |
| attributes.**publishable\_key**          | `string`  | The gateway publishable API key.                                                                                                                                                                    |
| attributes.**connected\_account**        | `string`  | The account (if any) for which the funds of the PaymentIntent are intended.                                                                                                                         |
| attributes.**auto\_payments**            | `boolean` | Indicates if the gateway will accept payment methods enabled in the Stripe dashboard.                                                                                                               |
| attributes.**webhook\_endpoint\_id**     | `string`  | The gateway webhook endpoint ID, generated automatically.                                                                                                                                           |
| attributes.**webhook\_endpoint\_secret** | `string`  | The gateway webhook endpoint secret, generated automatically.                                                                                                                                       |
| attributes.**webhook\_endpoint\_url**    | `string`  | The gateway webhook URL, generated automatically.                                                                                                                                                   |
| relationships.**payment\_methods**       | `array`   | The associated payment methods.                                                                                                                                                                     |
| relationships.**event\_stores**          | `array`   | The associated event stores.                                                                                                                                                                        |
| relationships.**stripe\_payments**       | `array`   | The associated payments.                                                                                                                                                                            |
| 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_gateways/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.