Skip to main content
POST
/
payment-instruments
/
{token}
/
vault
Save a payment method token
curl --request POST \
  --url https://api.sandbox.primer.io/payment-instruments/{token}/vault \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "customerId": "<string>"
}
'
{
  "createdAt": "2021-03-01T12:00:00.123456",
  "token": "_xlXlmBcTnuFxc2N3HAI73wxNjE1NTU5ODY5",
  "tokenType": "MULTI_USE",
  "analyticsId": "vuXhpZouWxaZpRZ-x_brZmtT",
  "paymentMethodType": "PAYMENT_CARD",
  "paymentMethodData": {
    "last4Digits": "1111",
    "expirationMonth": "12",
    "expirationYear": "2030",
    "cardholderName": "John Biggins",
    "network": "Visa",
    "networkTransactionId": "020210628190752",
    "accountFundingType": "DEBIT"
  },
  "customerId": "customer-123",
  "deleted": false,
  "default": true
}

Authorizations

​
X-API-KEY
string
header
required

Path Parameters

​
token
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
PaymentCardTokenAPISchemaPaymentMethodsAPI · object

Used exclusively by the Payment Methods API

​
customerId
string

The ID representing the customer

​
default
boolean
default:false

Whether or not this payment method is the default