order APIv1_beta.29.1

PaymentMethod

The type that defines the fields for the payment method.

Types that use PaymentMethod

CheckoutSessionResponse,GuestCheckoutSessionResponse

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_payment_info
POST
/checkout_session/{checkoutSessionId}/update_quantity
POST
/checkout_session/{checkoutSessionId}/update_shipping_address
POST
/checkout_session/{checkoutSessionId}/update_shipping_option
POST
/guest_checkout_session/{checkoutSessionId}/apply_coupon
POST
/guest_checkout_session/{checkoutSessionId}/remove_coupon
POST
/proxy_guest_checkout_session/{checkoutSessionId}/apply_coupon
POST
/proxy_guest_checkout_session/{checkoutSessionId}/remove_coupon
GET
/guest_checkout_session/{checkoutSessionId}
POST
/guest_checkout_session/initiate
POST
/guest_checkout_session/{checkoutSessionId}/initiate_payment
POST
/guest_checkout_session/{checkoutSessionId}/update_payment_info
POST
/guest_checkout_session/{checkoutSessionId}/update_quantity
POST
/guest_checkout_session/{checkoutSessionId}/update_shipping_address
POST
/guest_checkout_session/{checkoutSessionId}/update_shipping_option
GET
/proxy_guest_checkout_session/{checkoutSessionId}
POST
/proxy_guest_checkout_session/initiate
POST
/proxy_guest_checkout_session/{checkoutSessionId}/update_payment_info
POST
/proxy_guest_checkout_session/{checkoutSessionId}/update_quantity
POST
/proxy_guest_checkout_session/{checkoutSessionId}/update_shipping_address
POST
/proxy_guest_checkout_session/{checkoutSessionId}/update_shipping_option

Fields

Field
Type
Description
label
string
Text indicating the payment type. For example, when paying by credit card, this value will be CC. When paying using PayPal Smart Button eBay guest payment flow the value will be WALLET.
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.