Increase.CardValidations.CardValidation (Increase v1.0.0)

Copy Markdown View Source

Card Validations are used to validate a card and its cardholder before sending funds to or pulling funds from a card.

Fields

  • id - The Card Validation's identifier.
  • acceptance - If the validation is accepted by the recipient bank, this will contain supplemental details.
  • account_id - The identifier of the Account from which to send the validation.
  • card_token_id - The ID of the Card Token that was used to validate the card.
  • cardholder_first_name - The cardholder's first name.
  • cardholder_last_name - The cardholder's last name.
  • cardholder_middle_name - The cardholder's middle name.
  • cardholder_postal_code - The postal code of the cardholder's address.
  • cardholder_street_address - The cardholder's street address.
  • created_at - The ISO 8601 date and time at which the validation was created.
  • created_by - What object created the validation, either via the API or the dashboard.
  • decline - If the validation is rejected by the card network or the destination financial institution, this will contain supplemental details.
  • idempotency_key - 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_code - A four-digit code (MCC) identifying the type of business or service provided by the merchant.
  • merchant_city_name - The city where the merchant (typically your business) is located.
  • merchant_name - The merchant name that will appear in the cardholder’s statement descriptor. Typically your business name.
  • merchant_postal_code - The postal code for the merchant’s (typically your business’s) location.
  • merchant_state - The U.S. state where the merchant (typically your business) is located.
  • route - The card network route used for the validation.
  • status - The lifecycle status of the validation.
  • submission - After the validation is submitted to the card network, this will contain supplemental details.
  • type - A constant representing the object's type. For this resource it will always be card_validation.

Summary

Types

t()

Types

t()

@type t() :: %Increase.CardValidations.CardValidation{
  acceptance: Increase.CardValidations.CardValidation.Acceptance.t() | nil,
  account_id: String.t(),
  card_token_id: String.t(),
  cardholder_first_name: String.t() | nil,
  cardholder_last_name: String.t() | nil,
  cardholder_middle_name: String.t() | nil,
  cardholder_postal_code: String.t() | nil,
  cardholder_street_address: String.t() | nil,
  created_at: DateTime.t(),
  created_by: Increase.CardValidations.CardValidation.CreatedBy.t() | nil,
  decline: Increase.CardValidations.CardValidation.Decline.t() | nil,
  id: String.t(),
  idempotency_key: String.t() | nil,
  merchant_category_code: String.t(),
  merchant_city_name: String.t(),
  merchant_name: String.t(),
  merchant_postal_code: String.t(),
  merchant_state: String.t(),
  route: String.t(),
  status: String.t(),
  submission: Increase.CardValidations.CardValidation.Submission.t() | nil,
  type: String.t()
}