Sign in
Payment Methods API

Save a payment method token

Save a `SINGLE_USE` payment method token so it can be used again later. If you try to vault an already vaulted token, you will get the existing vaulted token back.

post/payment-instruments/{paymentMethodToken}/vault

Path parameters

paymentMethodTokenstring required

Payment method token

Payment method token to store.

Headers

X-API-VERSIONstring required
Example:2.4

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

Request body

customerIdstring required

The ID representing the customer

Response

Successful Response

createdAtstring date-time required

Creation date & time of the object (UTC)

deletedAtstring date-time

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

deletedboolean

Whether or not this object has been revoked.

tokenstring required

The vaulted payment method token.

tokenTypestring required
  • MULTI_USE a vaulted token that can be re-used with subsequent payments
analyticsIdstring required

Unique analytics identifier corresponding to a payment method

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

Payment method type, where OFF_SESSION_PAYMENT is used for APM (Alternative Payment Method) payments and PAYMENT_CARD for traditional debit or credit cards. Please note that this list is different from one indicated on available payment methods page and values of this field will be changed in the future versions of the API.

customerIdstring required

The ID representing the customer

descriptionstring

A friendly description given by the user

defaultboolean required

Whether or not this payment method is the default

Example response

{
  "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
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.