API ReferencePayment Methods API

Update the default saved payment method

Update a saved payment method to be the default stored payment method for a customer.

Path parameters

paymentMethodTokenstringRequired

Saved payment method token to set to default.

Headers

X-API-KEYstringRequired

Response

Successful Response

createdAtdatetimeOptional

Creation date & time of the object (UTC)

deletedAtdatetimeOptional

Date & time when this object was revoked. (UTC)

deletedbooleanOptional

Whether or not this object has been revoked.

tokenstringOptional

The vaulted payment method token.

tokenTypestringOptional
  • MULTI_USE a vaulted token that can be re-used with subsequent payments
analyticsIdstringOptional

Unique analytics identifier corresponding to a payment method

paymentMethodTypeenumOptional

Payment method type associated with a token.

paymentMethodDataobjectOptional

Payment method data

customerIdstringOptional

The ID representing the customer

descriptionstringOptional

A friendly description given by the user

defaultbooleanOptionalDefaults to false

Whether or not this payment method is the default

Errors