Skip to main content

Interface: CreatePaymentMethodRequest

Extends

Properties

address_ids?

optional address_ids: number[]

Array of address ids the new payment methods should be associated to


billing_address?

optional billing_address: AssociatedAddress

An object with the customer’s address information.

Inherited from

SubType.billing_address


default?

optional default: boolean

If this is the default payment method for the customer

Inherited from

SubType.default


external_mandate_id?

optional external_mandate_id: string

like “mandate_1O7lt8FHTwP5c651R…”


payment_type

payment_type: PaymentType

The type of payment this is. If passed, must also be accompanied by one of stripe_customer_token, paypal_customer_token or authorizedotnet_customer_token in processor_payment_method_token.

Inherited from

SubType.payment_type


processor_customer_token

processor_customer_token: string

The customer token at the processor.

Inherited from

SubType.processor_customer_token


processor_name

processor_name: ProcessorName

This will impact validation on billing_details. Currently, shopify_payments is in read-only mode and can only be managed by Shopify.

Inherited from

SubType.processor_name


processor_payment_method_token

processor_payment_method_token: string

The payment token at the processor.

Inherited from

SubType.processor_payment_method_token