Request
This endpoint expects an object.
namestringRequired
Cardholder name or account holder name
midstringRequired
Merchant ID associated with this vault
account_tokenstringRequired
Tokenized representation of the payment account.
vault_idintegerOptional
Unique identifier for the vault payment method. *Required if updating an existing vault.
is_defaultbooleanOptional
Whether this is the default payment method for the customer
address1stringOptional
Billing address line 1
citystringOptional
Billing address city
regionstringOptional
Billing address state/province/region
countrystringOptional
Billing address country code
account_zipstringOptional
Billing address ZIP/postal code
emailstringOptional
Customer email address
phonestringOptional
Customer phone number
custom06stringOptional
Custom field for merchant-specific data
custom07stringOptional
Custom field for merchant-specific data
custom08stringOptional
Custom field for merchant-specific data
custom09stringOptional
Custom field for merchant-specific data
custom10stringOptional
Custom field for merchant-specific data
Response
Vault payment account created successfully
uuidstringformat: "uuid"
Universal unique identifier for the payment account
vault_idinteger
Unique identifier for the vault payment method
midstring
Merchant ID associated with this vault
namestring
Cardholder name or account holder name
account_typeinteger
Type of payment account (1=Credit, 2=Debit, 3=Checking, 4=Savings)
is_defaultboolean
Whether this is the default payment method for the customer
zipcodestring
Billing address ZIP/postal code
address1string
Billing address line 1
address2string or null
Billing address line 2
citystring
Billing address city
regionstring
Billing address state/province/region
countrystring
Billing address country code
phonestring
Customer phone number
emailstring
Customer email address
account_tokenstring
Tokenized representation of the payment account
custom06string or null
Custom field for merchant-specific data
custom07string or null
Custom field for merchant-specific data
custom08string or null
Custom field for merchant-specific data
custom09string or null
Custom field for merchant-specific data
custom10string or null
Custom field for merchant-specific data
created_datestringformat: "date-time"
Timestamp when the vault was created
