Add a Card Account

post

https://sandbox-api.prioritycommerce.com/v1/checkout/v3/customercardaccount/{id}

Adds the CardAccount.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

int64

required

Customer ID

Query Params

echo

boolean

Defaults to true

If true, the API will echo the full payment resource in the response body

Body Params

CardAccount information

Represents Payment Card information

isDefault

boolean

whether this is the default card account

alias

string

Easy to remember name for the card.
Can be used as an additional identifier.

token

string

Vaulted Payment Token

number

string

Card number. Either this or magstripe must be present.

expiryMonth

string

Card Expiration Month

expiryYear

string

Card Expiration Year

magstripe

string

Magnetic Stripe Data for this transaction. Either this or card number must be present. If magstripe is provided, expiryMonth and year is not nessessary.

cvv

string

3 or 4 digit card verification value (CVV) (required if Loss Prevention Setting is turned on)

name

string

Cardholder's name

avsStreet

string

Billing Street Address (required if Loss Prevention Setting is turned on)

avsZip

string

Billing Zip Code (required if Loss Prevention Setting is turned on)

supportNumber

string

The support phone number printed on the back of the card

emvData

string

Byte array converted to string - ICC, chip data for EMV transactions

cardPresent

boolean

Indicates if the card is physically present at the time of payment

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201The entity has been created successfully.

400The request could not be accepted by the MXM server due to a malformed syntax, which may be a missing required parameter or other syntactical error.

401The request could not be authenticated. The API key or access token may be missing, invalid, or expired.

403The authenticated user does not have permission to perform this action on the requested resource.

422The MXM server understood the request but was unable to process it due to semantic errors or invalid field values in the request body.

500An unexpected error occurred on the MXM server. If the issue persists, please contact support.

503The MXM server is temporarily unable to handle the request. Please retry after a short delay.