Save a payment method token — Primer

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.

Path parameters

paymentMethodTokenstringRequired

Payment method token to store.

Request

This endpoint expects an object.

customerIdstringRequired>=1 character

The ID representing the customer

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

1 curl -X POST https://api.sandbox.primer.io/payment-instruments/paymentMethodToken/vault \ 2 -H "X-API-KEY: <apiKey>" \ 3 -H "Content-Type: application/json" \ 4 -d '{ 5 "customerId": "customerId" 6 }'

1 { 2 "createdAt": "2021-03-01T12:00:00Z", 3 "deletedAt": "2024-01-15T09:30:00Z", 4 "deleted": false, 5 "token": "_xlXlmBcTnuFxc2N3HAI73wxNjE1NTU5ODY5", 6 "tokenType": "MULTI_USE", 7 "analyticsId": "vuXhpZouWxaZpRZ-x_brZmtT", 8 "paymentMethodType": "PAYMENT_CARD", 9 "paymentMethodData": { 10 "first6Digits": "first6Digits", 11 "last4Digits": "last4Digits", 12 "expirationMonth": "expirationMonth", 13 "expirationYear": "expirationYear", 14 "cardholderName": "cardholderName", 15 "network": "network", 16 "isNetworkTokenized": true, 17 "binData": { 18 "network": "AMEX", 19 "issuerCountryCode": "AW", 20 "issuerName": "issuerName", 21 "issuerCurrencyCode": "AED", 22 "regionalRestriction": "DOMESTIC_USE_ONLY", 23 "accountNumberType": "PRIMARY_ACCOUNT_NUMBER", 24 "accountFundingType": "CREDIT", 25 "prepaidReloadableIndicator": "RELOADABLE", 26 "productUsageType": "CONSUMER", 27 "productCode": "productCode", 28 "productName": "productName" 29 } 30 }, 31 "customerId": "customer-123", 32 "description": "My first card", 33 "default": true 34 }

1	curl -X POST https://api.sandbox.primer.io/payment-instruments/paymentMethodToken/vault \
2	-H "X-API-KEY: <apiKey>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"customerId": "customerId"
6	}'

1	{
2	"createdAt": "2021-03-01T12:00:00Z",
3	"deletedAt": "2024-01-15T09:30:00Z",
4	"deleted": false,
5	"token": "_xlXlmBcTnuFxc2N3HAI73wxNjE1NTU5ODY5",
6	"tokenType": "MULTI_USE",
7	"analyticsId": "vuXhpZouWxaZpRZ-x_brZmtT",
8	"paymentMethodType": "PAYMENT_CARD",
9	"paymentMethodData": {
10	"first6Digits": "first6Digits",
11	"last4Digits": "last4Digits",
12	"expirationMonth": "expirationMonth",
13	"expirationYear": "expirationYear",
14	"cardholderName": "cardholderName",
15	"network": "network",
16	"isNetworkTokenized": true,
17	"binData": {
18	"network": "AMEX",
19	"issuerCountryCode": "AW",
20	"issuerName": "issuerName",
21	"issuerCurrencyCode": "AED",
22	"regionalRestriction": "DOMESTIC_USE_ONLY",
23	"accountNumberType": "PRIMARY_ACCOUNT_NUMBER",
24	"accountFundingType": "CREDIT",
25	"prepaidReloadableIndicator": "RELOADABLE",
26	"productUsageType": "CONSUMER",
27	"productCode": "productCode",
28	"productName": "productName"
29	}
30	},
31	"customerId": "customer-123",
32	"description": "My first card",
33	"default": true
34	}