v4

OpenAPI 3.1.02026-08-012402353.8 MB

Retrieve a Card Validation

get/card_validations/{card_validation_id}

Path parameters

card_validation_idstring required

The identifier of the Card Validation.

Response

Card Validation

account_idstring required

The identifier of the Account from which to send the validation.

card_token_idstring required

The ID of the Card Token that was used to validate the card.

cardholder_first_namestring nullable required

The cardholder's first name.

cardholder_last_namestring nullable required

The cardholder's last name.

cardholder_middle_namestring nullable required

The cardholder's middle name.

cardholder_postal_codestring nullable required

The postal code of the cardholder's address.

cardholder_street_addressstring nullable required

The cardholder's street address.

created_atstring date-time required

The ISO 8601 date and time at which the validation was created.

idstring required

The Card Validation's identifier.

idempotency_keystring nullable required

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.

merchant_category_codestring required

A four-digit code (MCC) identifying the type of business or service provided by the merchant.

merchant_city_namestring required

The city where the merchant (typically your business) is located.

merchant_namestring required

The merchant name that will appear in the cardholder’s statement descriptor. Typically your business name.

merchant_postal_codestring required

The postal code for the merchant’s (typically your business’s) location.

merchant_statestring required

The U.S. state where the merchant (typically your business) is located.

route'visa' | 'mastercard' | 'pulse' required

The card network route used for the validation.

status'requires_attention' | 'pending_submission' | 'submitted' | 'complete' | 'declined' required

The lifecycle status of the validation.

type'card_validation' required

A constant representing the object's type. For this resource it will always be card_validation.

Example response

{
  "acceptance": {
    "accepted_at": "2020-01-31T23:59:59Z",
    "authorization_identification_response": "ABCDEF",
    "card_verification_value2_result": null,
    "cardholder_first_name_result": null,
    "cardholder_full_name_result": null,
    "cardholder_last_name_result": null,
    "cardholder_middle_name_result": null,
    "cardholder_postal_code_result": null,
    "cardholder_street_address_result": null,
    "network_transaction_identifier": "841488484271872"
  },
  "account_id": "account_in71c4amph0vgo2qllky",
  "card_token_id": "outbound_card_token_zlt0ml6youq3q7vcdlg0",
  "cardholder_first_name": "Dee",
  "cardholder_last_name": "Hock",
  "cardholder_middle_name": "Ward",
  "cardholder_postal_code": "10045",
  "cardholder_street_address": "33 Liberty Street",
  "created_at": "2020-01-31T23:59:59Z",
  "created_by": {
    "category": "user",
    "user": {
      "email": "user@example.com"
    }
  },
  "decline": {
    "declined_at": "2020-01-31T23:59:59Z",
    "network_transaction_identifier": "841488484271872",
    "reason": "transaction_not_permitted_to_cardholder"
  },
  "id": "outbound_card_validation_qqlzagpc6v1x2gcdhe24",
  "idempotency_key": null,
  "merchant_category_code": "1234",
  "merchant_city_name": "New York",
  "merchant_name": "Acme Corp",
  "merchant_postal_code": "10045",
  "merchant_state": "NY",
  "route": "visa",
  "status": "pending_submission",
  "submission": {
    "retrieval_reference_number": "123456789012",
    "submitted_at": "2020-01-31T23:59:59Z",
    "trace_number": "123456"
  },
  "type": "card_validation"
}