The payment method object

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

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

FieldTypeDescription

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', 'credit_cards', '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.attachments

array

The associated attachments.

relationships.versions

array

The associated changes.

meta.mode

string

The resource environment (can be one of test or live)

Last updated