Payment methods
Payment methods represent the type of payment sources (e.g., Credit Card, PayPal, or Apple Pay) offered in a market. They can have a price and must be present before placing an order.
A payment method object is returned as part of the response body of each successful create, list, retrieve, or update API call.
Field | Type | Description |
type |
|
|
id |
| The payment method unique identifier |
links.self |
| The payment method endpoint URL |
attributes.payment_source_type |
| Can be one of 'PaypalPayment', or 'CreditCard' |
attributes.name |
| Payment source type, titleized |
attributes.disabled_at |
| Time at which the payment method was disabled. |
attributes.price_amount_cents |
| The payment method's price, in cents |
attributes.price_amount_float |
| The payment method's price, float |
attributes.formatted_price_amount |
| The payment method's price, formatted |
attributes.created_at |
| Time at which the resource was created. |
attributes.updated_at |
| Time at which the resource was last updated. |
attributes.reference |
| 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 |
| Any identifier of the third party system that defines the reference code |
attributes.metadata |
| 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 |
| The associated market. |
relationships.payment_gateway |
| The associated payment gateway. |
meta.mode |
| The resource environment (can be one of |
