increase-test
POST/card_validations

Create a card validation

Creates a Card Validation to validate a card and its cardholder before sending funds to or pulling funds from a card. Supply the Account, Card Token, and merchant details; cardholder details are optional. Merchant category codes must contain exactly four digits, and text fields with character restrictions accept ASCII characters only.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

12 body fields

Card Validation details. Include account_id, card_token_id, merchant_city_name, merchant_state, merchant_postal_code, merchant_category_code, and merchant_name; cardholder details are optional.

account_idstringrequired
The identifier of the Account from which to send the validation.
card_token_idstringrequired
The Increase identifier for the Card Token that represents the card number you're validating.
cardholder_first_namestringoptional
The cardholder's first name.
cardholder_last_namestringoptional
The cardholder's last name.
cardholder_middle_namestringoptional
The cardholder's middle name.
cardholder_postal_codestringoptional
The postal code of the cardholder's address.
cardholder_street_addressstringoptional
The cardholder's street address.
merchant_category_codestringrequired
A four-digit code (MCC) identifying the type of business or service provided by the merchant.
merchant_city_namestringrequired
The city where the merchant (typically your business) is located.
merchant_namestringrequired
The merchant name that will appear in the cardholder’s statement descriptor. Typically your business name.
merchant_postal_codestringrequired
The postal code for the merchant’s (typically your business’s) location.
merchant_statestringrequired
The U.S. state where the merchant (typically your business) is located.

3 status codes
200Returns the created Card Validation object, including its identifier, Account and Card Token identifiers, merchant details, status, and creation time.
acceptanceobjectrequired
If the validation is accepted by the recipient bank, this will contain supplemental details.
account_idstringrequired
The identifier of the Account from which to send the validation.
card_token_idstringrequired
The ID of the Card Token that was used to validate the card.
cardholder_first_namestringrequired
The cardholder's first name.
cardholder_last_namestringrequired
The cardholder's last name.
cardholder_middle_namestringrequired
The cardholder's middle name.
cardholder_postal_codestringrequired
The postal code of the cardholder's address.
cardholder_street_addressstringrequired
The cardholder's street address.
created_atstringrequired
The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the validation was created.
created_byobjectrequired
What object created the validation, either via the API or the dashboard.
declineobjectrequired
If the validation is rejected by the card network or the destination financial institution, this will contain supplemental details.
idstringrequired
The Card Validation's identifier.
idempotency_keystringrequired
The idempotency key you chose for this object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about [idempotency](https://increase.com/documentation/idempotency-keys).
merchant_category_codestringrequired
A four-digit code (MCC) identifying the type of business or service provided by the merchant.
merchant_city_namestringrequired
The city where the merchant (typically your business) is located.
merchant_namestringrequired
The merchant name that will appear in the cardholder’s statement descriptor. Typically your business name.
merchant_postal_codestringrequired
The postal code for the merchant’s (typically your business’s) location.
merchant_statestringrequired
The U.S. state where the merchant (typically your business) is located.
routestringrequired
The card network route used for the validation.
Allowed:visamastercardpulse
statusstringrequired
The lifecycle status of the validation.
Allowed:requires_attentionpending_submissionsubmittedcompletedeclined
submissionobjectrequired
After the validation is submitted to the card network, this will contain supplemental details.
typestringrequired
A constant representing the object's type. For this resource it will always be `card_validation`.
Allowed:card_validation
4XXReturned when the request is invalid or cannot be processed.
5XXReturned when the server encounters an error processing the request.

Error handling

account_id, card_token_id, merchant_city_name, merchant_state, merchant_postal_code, merchant_category_code, and merchant_name are required. merchant_category_code must contain exactly four digits; the other merchant fields must satisfy their stated length limits, and the cardholder fields must contain only ASCII characters and meet their stated length limits.