Create customer vault
Create a new customer vault. Payment methods are provided as a cards array. The first card in the array is automatically set as the default payment method.
Required: firstName, lastName.
Optional: companyName, phoneNumber, email (recommended — required for subscription flows), zipCode, billingAddress, shippingAddress, gender, dateOfBirth.
Card fields: name, number (masked, e.g. 411111******1111), exp (MMYY format), paymentToken (from tokenization form), zipCode.
Test mode token: 00000000-000000-000000-000000000000.
Create customer vault › Request Body
clientIdClient identifier
firstNameFirst Name of the cardholder
lastNameLast Name of the cardholder
emailCustomer's email
zipCodeZip Code
Customer's card
phoneNumberCustomer's phone number
companyNameCardholder's company name (If any)
dateOfBirthDate of birth
genderGender
Create customer vault › Responses
Customer vault created.
Update customer
Partial update of a customer vault.
path Parameters
idCustomer vault ID
Update customer › Request Body
clientIdClient identifier
firstNameFirst Name of the cardholder
lastNameLast Name of the cardholder
zipCodeZip Code
Customer's card
phoneNumberCustomer's phone number
emailCustomer's email
companyNameCardholder's company name (If any)
dateOfBirthDate of birth
genderGender
Update customer › Responses
Customer updated.
Delete customer card
Remove a stored card from a customer vault. Note: If the card has an active subscription associated with it, deletion will be rejected with an error. Cancel or reassign the subscription first.
path Parameters
customerVaultIdCustomer vault ID
idStored card vault ID
Delete customer card › Responses
Card removed.
Update vault card by id
Update an existing stored card in a customer vault.
path Parameters
idCustomer vault ID
customerVaultIdStored card vault ID
Update vault card by id › Request Body
nameName of card
last4Last4 of card
networkType of card (visa, mastercard...)
numberNumber of card
expExp date of card
zipCodeMerchant Zipcode
customerVaultIdCustomer Vault Id
paymentTokenPayment token
tokenPayment token BP
Update vault card by id › Responses
Card updated.
Bulk update request
Send a payment-update request link to multiple existing customers at once. Equivalent to calling /update-request/:id for each customer.
Body fields: itemList (array of customer IDs), expirationTime (number), unitOfTime (minutes, hours, days, weeks).
Headers
authorizationBulk update request › Request Body
itemListBulk Action list of items
expirationTimeLife time of the request
unitOfTimeUnit of time (minutes, days, hours, weeks)
Bulk update request › Responses
Requests sent.
Send invitation to new customer
Send a secure link so that a new customer can enter their own payment details. Use this for new customers only — for existing customers use /update-request/:id.
Body fields: expirationTime (required, number), unitOfTime (required: minutes, hours, days, weeks), email (optional), phoneNumber (optional, any valid US number including area code, e.g. 786 322 0000).
Headers
authorizationSend invitation to new customer › Request Body
expirationTimeLife time of the request
unitOfTimeUnit of time (minutes, days, hours, weeks)
phoneNumberCustomer phone number
emailCustomer email address
Send invitation to new customer › Responses
Invitation sent.
Send update request to existing customer
Send a secure link to an existing customer so they can update their payment details. Use when a customer's payment info is incomplete, missing, or needs to be changed.
Body fields: expirationTime (required, number), unitOfTime (required: minutes, hours, days, weeks), email (optional), phoneNumber (optional, any valid US number including area code).
path Parameters
idCustomer vault ID
Headers
authorizationSend update request to existing customer › Request Body
expirationTimeLife time of the request
unitOfTimeUnit of time (minutes, days, hours, weeks)
phoneNumberCustomer phone number
emailCustomer email address
Send update request to existing customer › Responses
Request sent.
Add card to customer vault
Add a new stored card (payment method) to an existing customer vault.
Required fields: number (masked, e.g. 411111******1111), paymentToken (from tokenization form, single-use).
Optional: name, exp (MMYY format), zipCode, billingAddress.
Test mode token: 00000000-000000-000000-000000000000.
zipCode regex: /^[0-9]{5}(?:-[0-9]{4})?$/g.
path Parameters
idCustomer vault ID
Add card to customer vault › Request Body
nameName of card
last4Last4 of card
networkType of card (visa, mastercard...)
numberNumber of card
expExp date of card
zipCodeMerchant Zipcode
customerVaultIdCustomer Vault Id
paymentTokenPayment token
tokenPayment token BP
Add card to customer vault › Responses
Card added.