Skip to main content
POST
Save a payment method token

Authorizations

X-API-KEY
string
header
required

Path Parameters

paymentMethodToken
string
required

Payment method token

Body

application/json
customerId
string
required

The ID representing the customer

Minimum string length: 1

Response

Successful Response

createdAt
string<date-time>

Creation date & time of the object (UTC)

deletedAt
string<date-time>

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

deleted
boolean

Whether or not this object has been revoked.

token
string

The vaulted payment method token.

tokenType
string
  • MULTI_USE a vaulted token that can be re-used with subsequent payments
analyticsId
string

Unique analytics identifier corresponding to a payment method

paymentMethodType
enum<string>

Payment method type associated with a token.

Available options:
PAYMENT_CARD,
PAYPAL_ORDER,
PAYPAL_BILLING_AGREEMENT,
KLARNA_AUTHORIZATION_TOKEN,
KLARNA_CUSTOMER_TOKEN,
PAY_NL_IDEAL,
APAYA,
OFF_SESSION_PAYMENT,
CARD_OFF_SESSION_PAYMENT,
APPLE_PAY,
APPLE_PAY_ENCRYPTED_TOKEN,
GOOGLE_PAY,
AUTOMATED_CLEARING_HOUSE
paymentMethodData
PaymentCardTokenAPISchema · object

Payment method data

customerId
string

The ID representing the customer

description
string

A friendly description given by the user

default
boolean
default:false

Whether or not this payment method is the default