v1-tokens-cc-request-1.md

V1 Tokens Cc Request 1

Structure

V1TokensCcRequest1

Fields

Name	Type	Tags	Description	Getter	Setter
accountHolderName	?string	Optional	Account holder name Constraints: Minimum Length: 1, Maximum Length: 32	getAccountHolderName(): ?string	setAccountHolderName(?string accountHolderName): void
accountNumber	?string	Optional	Account number	getAccountNumber(): ?string	setAccountNumber(?string accountNumber): void
accountVaultApiId	?string	Optional	This field can be used to correlate Tokens in our system to data within an outside software integration Constraints: Minimum Length: 1, Maximum Length: 36	getAccountVaultApiId(): ?string	setAccountVaultApiId(?string accountVaultApiId): void
accountvaultC1	?string	Optional	Custom field 1 for API users to store custom data Constraints: Minimum Length: 1, Maximum Length: 128	getAccountvaultC1(): ?string	setAccountvaultC1(?string accountvaultC1): void
accountvaultC2	?string	Optional	Custom field 2 for API users to store custom data Constraints: Minimum Length: 1, Maximum Length: 128	getAccountvaultC2(): ?string	setAccountvaultC2(?string accountvaultC2): void
accountvaultC3	?string	Optional	Custom field 3 for API users to store custom data Constraints: Minimum Length: 1, Maximum Length: 128	getAccountvaultC3(): ?string	setAccountvaultC3(?string accountvaultC3): void
achSecCode	?string (AchSecCode3Enum)	Optional	SEC code for the account	getAchSecCode(): ?string	setAchSecCode(?string achSecCode): void
billingAddress	?BillingAddress	Optional	Billing Address Object	getBillingAddress(): ?BillingAddress	setBillingAddress(?BillingAddress billingAddress): void
contactId	?string	Optional	Used to associate the Token with a Contact. Constraints: Pattern: ^(([0-9a-fA-F]{24})|(([0-9a-fA-F]{8})-(([0-9a-fA-F]{4}\-){3})([0-9a-fA-F]{12})))$	getContactId(): ?string	setContactId(?string contactId): void
customerId	?string	Optional	Used to store a customer identification number. Constraints: Minimum Length: 1, Maximum Length: 50	getCustomerId(): ?string	setCustomerId(?string customerId): void
identityVerification	?IdentityVerification2	Optional	Identity verification	getIdentityVerification(): ?IdentityVerification2	setIdentityVerification(?IdentityVerification2 identityVerification): void
locationId	?string	Optional	A valid Location Id associated with the Contact for this Token Constraints: Pattern: ^(([0-9a-fA-F]{24})|(([0-9a-fA-F]{8})-(([0-9a-fA-F]{4}\-){3})([0-9a-fA-F]{12})))$	getLocationId(): ?string	setLocationId(?string locationId): void
previousAccountVaultApiId	?string	Optional	Can be used to pull payment info from a previous token api id. Constraints: Maximum Length: 64	getPreviousAccountVaultApiId(): ?string	setPreviousAccountVaultApiId(?string previousAccountVaultApiId): void
previousAccountVaultId	?string	Optional	Can be used to pull payment info from a previous token. Constraints: Pattern: ^(([0-9a-fA-F]{24})|(([0-9a-fA-F]{8})-(([0-9a-fA-F]{4}\-){3})([0-9a-fA-F]{12})))$	getPreviousAccountVaultId(): ?string	setPreviousAccountVaultId(?string previousAccountVaultId): void
previousTransactionId	?string	Optional	Can be used to pull payment info from a previous transaction. Constraints: Pattern: ^(([0-9a-fA-F]{24})|(([0-9a-fA-F]{8})-(([0-9a-fA-F]{4}\-){3})([0-9a-fA-F]{12})))$	getPreviousTransactionId(): ?string	setPreviousTransactionId(?string previousTransactionId): void
termsAgree	?bool	Optional	Terms agreement.	getTermsAgree(): ?bool	setTermsAgree(?bool termsAgree): void
termsAgreeIp	?string	Optional	The ip address of the client that agreed to terms.	getTermsAgreeIp(): ?string	setTermsAgreeIp(?string termsAgreeIp): void
title	?string	Optional	Used to describe the Token for easier identification within our UI. Constraints: Minimum Length: 1, Maximum Length: 16	getTitle(): ?string	setTitle(?string title): void
expDate	?string	Optional	Required for CC. The Expiration Date for the credit card. (MMYY format). Constraints: Pattern: ^(0[1-9]|1[0-2])[0-9]{2}$	getExpDate(): ?string	setExpDate(?string expDate): void
eSerialNumber	?string	Optional	E Serial Number Constraints: Maximum Length: 36, Pattern: ^[a-zA-Z0-9]*$	getESerialNumber(): ?string	setESerialNumber(?string eSerialNumber): void
eTrackData	?string	Optional	E Track Data	getETrackData(): ?string	setETrackData(?string eTrackData): void
eFormat	?string	Optional	E Format	getEFormat(): ?string	setEFormat(?string eFormat): void
eKeyedData	?string	Optional	E Keyed Data	getEKeyedData(): ?string	setEKeyedData(?string eKeyedData): void
runAvs	?bool	Optional	A flag that will override a product transactions run_avs_on_accountvault_create setting to determine if an avsonly transaction should be run prior to storing the token. When storing an token with tha run_avs flag, if the avsonly check fails account verification with the processor, the token will not be stored in the system. The meaning of the AVS response codes can be found here on this page.This is the new preferred method of validating a credit card and can be used instead of the legacy $1 auth only transaction.Using this flag overrides the default setting for the locations product transactions.	getRunAvs(): ?bool	setRunAvs(?bool runAvs): void
trackData	?string	Optional	Track Data from a magnetic card swipe. Constraints: Maximum Length: 256	getTrackData(): ?string	setTrackData(?string trackData): void
ticket	?string	Optional	A valid ticket that was created to store the token. Constraints: Maximum Length: 36	getTicket(): ?string	setTicket(?string ticket): void

Example (as JSON)

{
  "account_holder_name": null,
  "account_number": null,
  "account_vault_api_id": null,
  "accountvault_c1": null,
  "accountvault_c2": null,
  "accountvault_c3": null,
  "ach_sec_code": null,
  "billing_address": null,
  "contact_id": null,
  "customer_id": null,
  "identity_verification": null,
  "location_id": null,
  "previous_account_vault_api_id": null,
  "previous_account_vault_id": null,
  "previous_transaction_id": null,
  "terms_agree": null,
  "terms_agree_ip": null,
  "title": null,
  "exp_date": null,
  "e_serial_number": null,
  "e_track_data": null,
  "e_format": null,
  "e_keyed_data": null,
  "run_avs": null,
  "track_data": null,
  "ticket": null
}