Skip to main content

The type that defines the fields for reference information about the payment method. This is returned only if you have used the updatePaymentInfo method to change the payment method.

Type that uses ProvidedPaymentInstrument

CheckoutSessionResponse

Calls that use ProvidedPaymentInstrument

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
paymentInstrumentReference
PaymentInstrumentReference
The container that returns the payment reference, such as last four digits of a credit card.
paymentMethodBrand
PaymentMethodBrand
The container that returns the name and logo of the payment company (brand), such as Visa.
paymentMethodType
PaymentMethodTypeEnum
An enumeration value that indicates the method of payment, such as CREDIT_CARD.