Skip to main content

The type that defines the fields for the payment method.

Type that uses PaymentMethod

CheckoutSessionResponse

Calls that use PaymentMethod

POST
/checkout_session/{checkoutSessionId}/apply_coupon
GET
/checkout_session/{checkoutSessionId}
POST
/checkout_session/initiate
POST
/checkout_session/{checkoutSessionId}/remove_coupon
POST
/checkout_session/{checkoutSessionId}/update_add_on_services_status
POST
/checkout_session/{checkoutSessionId}/update_payment_info
POST
/checkout_session/{checkoutSessionId}/update_quantity
POST
/checkout_session/{checkoutSessionId}/update_shipping_address
POST
/checkout_session/{checkoutSessionId}/update_shipping_option

Fields

Field
Type
Description
label
string
Text indicating the payment type. Credit card is the only accepted payment method for Order v1. Therefore, this value will always be CC.
logoImage
Image
The URL of the image of the payment method logo.
paymentMethodBrands
array of PaymentMethodBrand
An array of credit card brands that can be used as the payment method.
paymentMethodMessages
array of PaymentMethodMessage
The type that defines the fields for legal messages and buyer consent verification.
paymentMethodType
PaymentMethodTypeEnum
An enumeration value that indicates the method of payment, such as credit card.