# The payment option object

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

## Fields

| Field                                | Type       | Description                                                                                                                                                                                                                                            |
| ------------------------------------ | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| **type**                             | `string`   | `payment_options`                                                                                                                                                                                                                                      |
| **id**                               | `string`   | The payment option unique identifier                                                                                                                                                                                                                   |
| links.**self**                       | `string`   | The payment option endpoint URL                                                                                                                                                                                                                        |
| attributes.**name**                  | `string`   | The payment option's name. Wehn blank is inherited by payment source type.                                                                                                                                                                             |
| 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.**data**                  | `object`   | The payment options data to be added to the payment source payload. Check payment specific API for more details.                                                                                                                                       |
| 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.**order**              | `object`   | The order associated to the payment options.                                                                                                                                                                                                           |
| relationships.**attachments**        | `array`    | The associated attachments.                                                                                                                                                                                                                            |
| relationships.**event\_stores**      | `array`    | The associated event stores.                                                                                                                                                                                                                           |
| meta.**mode**                        | `string`   | The resource environment (can be one of `test` or `live`)                                                                                                                                                                                              |