Skip to main content
POST
/
payment-instruments
/
{paymentMethodToken}
/
vault
Save a payment method token
curl --request POST \
  --url https://api.sandbox.primer.io/payment-instruments/{paymentMethodToken}/vault \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --header 'X-API-VERSION: <x-api-version>' \
  --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",
  "description": "My first card",
  "deleted": false,
  "default": true
}

Authorizations

​
X-API-KEY
string
header
required

Headers

​
X-API-VERSION
string
required

Specifies the version of the API to use. This must be set to 2.4.

Example:

"2.4"

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>
required

Creation date & time of the object (UTC)

​
token
string
required

The vaulted payment method token.

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

Unique analytics identifier corresponding to a payment method

​
paymentMethodType
enum<string>
required

Payment method type associated with a token.

Available options:
PAYMENT_CARD,
GOOGLE_PAY,
APPLE_PAY,
PAYPAL,
BANK_ACCOUNT,
KLARNA,
APAYA,
OPENNODE,
HOOLAH,
ATOME,
COINBASE,
NETS,
TWOC2P,
CLEARPAY,
SHOPEEPAY,
TRIPLE_A,
AFTERPAY,
NOL_PAY,
PAY_NL_IDEAL,
PAY_NL_BANCONTACT,
PAY_NL_DIRECT_DEBIT,
PAY_NL_SOFORT_BANKING,
PAY_NL_PAYPAL,
PAY_NL_PAYCONIQ,
PAY_NL_GIROPAY,
PAY_NL_P24,
PAY_NL_EPS,
PAY_NL_KAARTDIRECT,
ADYEN_SOFORT,
ADYEN_TWINT,
ADYEN_GIROPAY,
ADYEN_TRUSTLY,
ADYEN_ALIPAY,
ADYEN_MOBILEPAY,
ADYEN_MULTIBANCO,
ADYEN_VIPPS,
ADYEN_DOTPAY,
ADYEN_IDEAL,
ADYEN_BLIK,
ADYEN_PAYTRAIL,
ADYEN_INTERAC,
ADYEN_PAYSHOP,
ADYEN_MBWAY,
ADYEN_AFFIRM,
ADYEN_KLARNA,
ADYEN_BANCONTACT_PAYCONIQ,
ADYEN_EPS,
ADYEN_BANCONTACT_CARD,
ADYEN_SWISH,
MOLLIE_IDEAL,
MOLLIE_BANCONTACT,
MOLLIE_P24,
MOLLIE_GIROPAY,
MOLLIE_EPS,
MOLLIE_GIFTCARD,
MOLLIE_SOFORT,
NETAXEPT_PAYTRAIL,
BUCKAROO_IDEAL,
BUCKAROO_BANCONTACT,
BUCKAROO_SOFORT,
BUCKAROO_GIROPAY,
BUCKAROO_EPS,
RAPYD_GCASH,
RAPYD_PROMPTPAY,
RAPYD_GRABPAY,
RAPYD_POLI,
RAPYD_FAST,
XFERS_PAYNOW,
STRIPE_GIROPAY,
STRIPE_IDEAL,
ALIPAY_CN,
CHAI_KAKAOPAY,
CHAI_NAVER,
CHAI_TOSS,
XENDIT_DANA,
XENDIT_OVO,
XENDIT_SHOPEEPAY,
XENDIT_RETAIL_OUTLETS,
OMISE_PROMPTPAY,
OMISE_TRUEMONEY,
EBANX_PAGOFACIL,
PACYPAY_WECHAT,
PACYPAY_ALIPAY,
PACYPAY_ALIPAY_PLUS,
WORLDPAY_IDEAL,
IPAY88_CARD,
INGENICO_PAYPAL,
VOLT_PIX,
VOLT_BANK_TRANSFER,
BRAINTREE_VENMO,
THUNES_SPIRIT_OF_CADEAU,
THUNES_ILLICADO,
THUNES_CARTE_CADEAU_CONFORAMA,
THUNES_CHEQUE_FIDELITE_CONFORAMA,
SIPS_CPAY,
SIPS_CPAYCONFORAMA,
MONEXT_CETELEM,
MONEXT_CPAY
​
paymentMethodData
PaymentCardTokenAPISchema · object
required

Payment method data

​
customerId
string
required

The ID representing the customer

​
default
boolean
default:false
required

Whether or not this payment method is the default

​
deletedAt
string<date-time>

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

​
deleted
boolean

Whether or not this object has been revoked.

​
description
string

A friendly description given by the user