Sign in

v1

latestOpenAPI 3.1.02026-07-241660500.9 KB

Create vaulted card account

Store a customer's credit card on file

post/v3/customercardaccount

Query parameters

idinteger required

Customer id

echoboolean

Return results (otherwise, you will just see an HTTP response code)

Request body

codestring

Account Code (Default is card)

numberstring

Card Number

magstripestring

Magstripe data; you would send in this field instead of number and expiry fields

expiryMonthstring

Card expiration month

expiryYearstring

Card expiration year

avsZipstring

Billing zip code

avsStreetstring

Billing street address

cvvstring

Card verification value

namestring

Cardholder's name

isDefaultboolean

Is this card the primary card?

aliasstring

Add an additional identifier to your customerCardAccount object

Response

201

isDefaultboolean
idinteger
createdstring
aliasstring
cardTypestring
last4string
cardIdstring
tokenstring
expiryMonthstring
expiryYearstring
namestring
avsStreetstring
avsZipstring
hasContractboolean

Example response

{
  "isDefault": true,
  "id": 10000000532311,
  "created": "2019-10-24T15:40:54.63Z",
  "alias": "alias - credit",
  "cardType": "Visa",
  "last4": "3343",
  "cardId": "eXlrPIqkMmVxqnqTxmvMMJO0dOcf",
  "token": "TRKOO2SD9ZJAHYBTRUNNHBKJYCQWAUJS",
  "expiryMonth": "11",
  "expiryYear": "2038",
  "name": "NoTax Customer",
  "avsStreet": "1776 Main Street Unit 3",
  "avsZip": "30005"
}