The payment option object

A comprehensive list of the payment option resource's attributes and relationships

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, can be one of: 'adyen_payments', 'axerve_payments', 'braintree_payments', 'checkout_com_payments', 'credit_cards', '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.
meta.mode	string	The resource environment (can be one of test or live)