# The payment method object

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

## Fields

| Field                                                | Type       | Description                                                                                                                                                                                                                                            |
| ---------------------------------------------------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| **type**                                             | `string`   | `payment_methods`                                                                                                                                                                                                                                      |
| **id**                                               | `string`   | The payment method unique identifier                                                                                                                                                                                                                   |
| links.**self**                                       | `string`   | The payment method endpoint URL                                                                                                                                                                                                                        |
| attributes.**name**                                  | `string`   | The payment method's internal name.                                                                                                                                                                                                                    |
| attributes.**payment\_source\_type**                 | `string`   | The payment source type. One of 'adyen\_payments', 'axerve\_payments', 'braintree\_payments', 'checkout\_com\_payments', 'external\_payments', 'klarna\_payments', 'paypal\_payments', 'satispay\_payments', 'stripe\_payments', or 'wire\_transfers'. |
| attributes.**currency\_code**                        | `string`   | The international 3-letter currency code as defined by the ISO 4217 standard.                                                                                                                                                                          |
| attributes.**moto**                                  | `boolean`  | Send this attribute if you want to mark the payment as MOTO, must be supported by payment gateway.                                                                                                                                                     |
| attributes.**require\_capture**                      | `boolean`  | Send this attribute if you want to require the payment capture before fulfillment.                                                                                                                                                                     |
| attributes.**auto\_place**                           | `boolean`  | Send this attribute if you want to automatically place the order upon authorization performed asynchronously.                                                                                                                                          |
| attributes.**auto\_capture**                         | `boolean`  | Send this attribute if you want to automatically capture the payment upon authorization.                                                                                                                                                               |
| attributes.**price\_amount\_cents**                  | `integer`  | The payment method's price, in cents.                                                                                                                                                                                                                  |
| attributes.**price\_amount\_float**                  | `float`    | The payment method's price, float.                                                                                                                                                                                                                     |
| attributes.**formatted\_price\_amount**              | `string`   | The payment method's price, formatted.                                                                                                                                                                                                                 |
| attributes.**auto\_capture\_max\_amount\_cents**     | `integer`  | Send this attribute if you want to limit automatic capture to orders for which the total amount is equal or less than the specified value, in cents.                                                                                                   |
| attributes.**auto\_capture\_max\_amount\_float**     | `float`    | The automatic capture max amount, float.                                                                                                                                                                                                               |
| attributes.**formatted\_auto\_capture\_max\_amount** | `string`   | The automatic capture max amount, formatted.                                                                                                                                                                                                           |
| 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**                          | `datetime` | Time at which this resource was disabled.                                                                                                                                                                                                              |
| attributes.**created\_at**                           | `datetime` | Time at which the resource was created.                                                                                                                                                                                                                |
| attributes.**updated\_at**                           | `datetime` | 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.**market**                             | `object`   | The associated market.                                                                                                                                                                                                                                 |
| relationships.**payment\_gateway**                   | `object`   | The associated payment gateway.                                                                                                                                                                                                                        |
| relationships.**store**                              | `object`   | The associated store.                                                                                                                                                                                                                                  |
| relationships.**attachments**                        | `array`    | The associated attachments.                                                                                                                                                                                                                            |
| relationships.**versions**                           | `array`    | The associated changes.                                                                                                                                                                                                                                |
| relationships.**event\_stores**                      | `array`    | The associated event stores.                                                                                                                                                                                                                           |
| meta.**mode**                                        | `string`   | The resource environment (can be one of `test` or `live`)                                                                                                                                                                                              |