Overview

Engaging with the Vortex API for card payments necessitates a thorough understanding of the required fields. This comprehensive guide is designed to ensure you're well-equipped with the necessary information to initiate and process card payment transactions smoothly. By familiarizing yourself with these fields, you can maximize the efficiency and security of your payment operations on the Vortex platform.

Jump to the Fields Overview section.

Required Fields

Field	Type	Required	Description	Restrictions
externalId	string	R	Unique ID for your transaction.
vtxId	string		Vortex ID of the customer on this transaction.
originalExternalId	string		External ID of a referenced transaction, useful for returns and voiding.	When present, must be the External ID of an existing transaction
environment	string		environment.	should be in lowercase
batchExternalId	string		Refers to which batch the transaction belongs to.
meta.created	date-time	R	Transaction Date
transactionType	string	R	Transaction Type	See Transaction Type
authorizationIndicator	string		Authorization Indicator
moto	boolean	R	Mail Order Telephone Order.
ecom	boolean	R	Ecommerce or Internet.
currencyCode	string (SubType: alphanumeric)	R	Currency for this transaction, defaults to 'USD'.	3 character maximum. Alphanumeric
totalAmount	number SubType: currency	R	Total Amount	See Currency
cashbackAmount	number SubType: currency		Total Cashback Amount	See Currency
requestedAmount	number SubType: currency		Total Requested Amount	See Currency
tipAmount	number SubType: currency		Tip Amount	See Currency
taxAmount	number SubType: currency		Tax Amount	See Currency
surchargeAmount	number SubType: currency		Surcharge Amount	See Currency
recurring	boolean	R	Payment is Recurring.
dynamicDescriptor	string		If filled in, replaces merchant.name with a text description.	While there is no character limit, string may be truncated.
bankNetDate	date-time		Bank Net Date.
bankNetReferenceNumber	string		Bank Net Reference Number.
ecommerceSecurityLevelIndicator	alphanumeric (SubType: alphanumeric)		Ecommerce Security Level Indicator.	Maximum 3 characters. Alphanumeric
amexEci	number (SubType: integer)		Amex Eci (Electronic Commerce Indicator).	Integer between 0 and 99
singleMessage	boolean		Single Message.
specialCondition	string		Special Condition.	See Special Conditions
authCode	string (SubType: alphanumeric)		AuthCode.	Maximum 6 characters. Alphanumeric
merchant.name	string	R	Merchant Name.
merchant.accountId	string		Merchant Id.
merchant.sic	string	R	Standard Industrial Classification.	Maximum 4 characters
merchant.address.street1	string	R	Merchant Address 1
merchant.address.street2	string		Merchant Address 2
merchant.address.city	string	R	Merchant City
merchant.address.state	string	R	Merchant State
merchant.address.postalCode	string	R	Merchant Postal Code.	Must be valid 5 or 9 digit with dash US and CND Postal Code
merchant.address.country	string		Merchant County
merchant.businessType	string		Merchant Business Type Values.	See Merchant Business Type Values
merchant.processor.name	string	R	Processor Name
merchant.processor.bankNumber	string	R	Processor Bank Number.	Maximum 4 characters. Numeric
merchant.processor.platform	string		Processor Platform Name.	See Platform Name
merchant.sponsor.bin	string	R	Sponsor Buisness Identification Number.	Maximum 6 characters. See Alphanumeric
merchant.sponsor.ica	string	R	Sponsor Interbank Card Association Number.	Maximum 6 characters. See Alphanumeric
merchant.number	string	R	Merchant Number.	Maximum 16 characters. See Alphanumeric
merchant.email	string		Merchant Email
merchant.phone	string		Merchant Phone Number.
merchant.taxId	string (SubType: alphanumeric)		Merchant Tax Id.	Can only contain numbers. Must be length 9
merchant.legalEntity	string		Merchant Legal Entity.	See Legal Entity
merchant.ebt	object		Merchant ebt.
merchant.ebt.number	string (SubType: alphanumeric)		Merchant Ebt Number.	Maximum 253 characters. See Alphanumeric
merchant.ebtOld	object		Merchant ebtOld.
merchant.ebtOld.number	string (SubType: alphanumeric)		Merchant Ebt Old Number.	Maximum 253 characters. See Alphanumeric
merchant.americanExpress.program	string		American Express Program.
merchant.americanExpress.number	string (SubType: alphanumeric)	R (American Express Only)	American Express Number.	Maximum 15 characters. See Alphanumeric
merchant.discover.number	string (SubType: alphanumeric)	R (Discover Only)	Discover Number.	Maximum 15 characters. See Alphanumeric
merchant.discover.acquiringId	string (SubType: numeric)	R (Discover Only)	Aquiring Id.	Maximum 11 characters. See Alphanumeric
merchant.mvv	string (SubType: alphanumeric)		Merchant Verification Value.
merchant.volumeIndicator	string/number		Merchant Volume Indicator.	Number - Value between 0 and 99
merchant.singleMessageEnabled	boolean		Single Message Enabled.
merchant.debtRepayment	boolean		Debt Repayment.
submerchant.facilitatorId	string (SubType: numeric)		Submerchant Facilitator Id.	Maximum 11 characters. See Numeric
submerchant.merchantId	string (SubType: alphanumeric, only spaces not allowed)		Submerchant Merchant Id.	Maximum 15 characters. See Alphanumeric
submerchant.aggregatorId	string		Submerchant Aggregator Id.
submerchant.isoId	string		Submerchant ISO Id.
submerchant.acquirerReference	string		Submerchant AcquirerReference.
account.form	string		Account Form	See Card Form
account.accountHolderName	string		Name on the Account.
account.network	string		Account Network	This value will be inferred from the account number, if not provided. See Network
account.type	string		Account Type	See Account Type
account.number	string (optionally encrypted)	R	Account Number	Must be a valid credit card number
account.expiry	date-time	R	Expiration Date of the card.
account.pin.key	string (optionally encrypted)		Pin Key Encrypted.
account.pin.value	string (optionally encrypted)		Pin Value Encrypted.
account.securityCode	string (SubType: numeric)		Account Security Code.	Can only contain numbers
account.sequence	number		Account Sequence
account.avsPostalCode	string		Account Postal Code.	Must be valid 5 or 9 digit US or CND Postal Code
account.avsStreet	string		Account Street Address.
account.emvRequest	string (optionally encrypted)		EMV Request	Base-64 string
account.swipe.track1	string		Encrypted Card Track Data 1.
account.swipe.track2	string		Encrypted Card Track Data 2.
account.avsAccountOwnerNameGiven	string		AVS account owner name.
account.avsAccountOwnerNameMiddle	string		AVS account owner middle name.
account.avsAccountOwnerNameLast	string		AVS account owner last name.
account.token	object		Account token
account.cryptogram	string		Account Cryptogram.
account.eciIndicator	string		Account ECI Indicator.
account.avsAccountOwnerPhone	string		AVS account owner phone.
account.avsAccountOwnerEmail	string		AVS account owner email.
device.id	string (SubType: alphanumeric)		Device Id	Maximum 8 characters. See Alphanumeric
device.type	string		Device type	See Device type
device.accountCaptureMethod	string		Device Capture Method.	See Capture Method
device.pinCaptureCapability	string		PIN Capture Capabilbity.	See PIN Capture Capabilitiy
device.pinInputCapability	string		PIN Input Capability.	See PIN Input Capabilitiy
device.cardPresent	boolean		Is the card present at the time of payment?
device.cardholderPresence	string		Is cardholder present at the time of payment?	See Cardholder Presence
device.attendance	string		Device Attendance	See Device Attendance
device.location	string		Device Location	See Device Location
device.partialApprovalSupport	string		Partial Approval Support	See Partial Approval Support
device.inputCapability	string		Input Capability	See Input Capability
device.catLevel	string		CAT level	See CAT Level
device.transactionSecurity	string		Transaction Security	See Transaction Security
device.transactionStatus	string		Transaction Status	See Transaction Status
customer.name	string (SubType: alphanumeric)		Customer Full Name	Maximum 38 characters. See Alphanumeric
customer.firstName	string (SubType: alphanumeric)		Customer First Name	Maximum 15 characters. See Alphanumeric
customer.lastName	string (SubType: alphanumeric)		Customer Last Name	Maximum 30 characters. See Alphanumeric
customer.address.street1	string		Customer Street Address 1
customer.address.street2	string		Customer Street Address 2
customer.address.city	string		Customer Address City
customer.address.state	string		Customer Address State.
customer.address.postalCode	string		Customer Address Postal Code.	Must be valid 5 or 9 digit US and CND Postal Code
customer.address.country	string		Customer Address Country
customer.phone	string		Customer Phone
customer.email	string		Customer Email
customer.number	string		Customer Number
customer.taxId	string (SubType: numeric)		Customer Tax Id	Can only contain numbers. Must be length 9
customer.created	date-time		Customer Created Date
customer.ipAddress	string		Customer IP Address	Length can be max of 15
customer.hostName	string		Customer Host Name	Length can be max of 60
customer.browserType	string		Customer Browser Type	Length can be max of 60
shippingAddress.street1	string		Shipping Address Street 1
shippingAddress.street2	string		Shipping Address Street 2
shippingAddress.city	string		Shipping Address City
shippingAddress.state	string		Shipping Address State
shippingAddress.postalCode	string		Shipping Address Postal Code	Must be valid 5 or 9 digit US and CND Postal Code
shippingAddress.country	string		Shipping Address Country
aciRequest	string		Authorization Character Indicator
invoiceNumber	string (SubType: Alphanumeric)		Invoice Number	Maximum length of 8. See Alphanumeric
invoice	object		Collection of Invoices
invoice.number	string (SubType: Alphanumeric)		Invoice Number	Maximum length of 25. See Alphanumeric
invoice.discountRate	number		Discount Rate
invoice.discountAmount	number (SubType: Currency)		Discount Amount	See Currency
invoice.taxAmount	number (SubType: Currency)		Tax Amount	See Currency
invoice.taxRate	number		Tax Rate
invoice.taxExempt	boolean		Tax Exempt
invoice.dutyAmount	number (SubType: Currency)		Duty Amount	See Currency
invoice.freightAmount	number (SubType: Currency)		Freight Amount	See Currency
invoice.freightTaxAmount	number (SubType: Currency)		Freight Tax Amount	See Currency
invoice.freightTaxRate	number (SubType: Currency)		Invoice Freight Tax Rate
invoice.sourcePostalCode	string		Source Postal Code	Must be valid 5 or 9 digit US and CND Postal Code
invoice.destinationPostalCode	string		Destination Postal Code	Must be valid 5 or 9 digit US and CND Postal Code
invoice.destinationCountry	string		Destination Country
invoice.shippingMethod	string		Shipping Method
invoice.lineItems[].commodityCode	string (SubType: Alphanumeric)		Commodity Code	Maximum 16 characters. See Alphanumeric
invoice.lineItems[].description	string (SubType: Alphanumeric)		Line Item Description	Maximum 68 characters. See Alphanumeric
invoice.lineItems[].productCode	string (SubType: Alphanumeric)		Line Item Product Code	Maximum 20 characters. See Alphanumeric
invoice.lineItems[].quantity	number		Line Item Quantity
invoice.lineItems[].unit	string (SubType: Alphanumeric)		Line Item Unit	Maximum 12 characters. See Alphanumeric
invoice.lineItems[].unitCost	number (SubType: Currency)		Line Item Unit Cost	See Currency
invoice.lineItems[].discountRate	number		Line Item Discount Rate
invoice.lineItems[].discountAmount	number (SubType: Currency)		Line Item Discount Amount	See Currency
invoice.lineItems[].taxRate	number		Line Item Tax Rate
invoice.lineItems[].taxAmount	number (SubType: Currency)		Line Item Tax Amount	See Currency
invoice.lineItems[].taxExempt	boolean		Line Item Tax Exempt	See Currency
invoice.lineItems[].dutyAmount	number (SubType: Currency)		Line Item Duty Amount	See Currency
invoice.lineItems[].extendedAmount	number (SubType: Currency)		Line Item Extended Amount	See Currency
invoice.lineItems[].freightAmount	number (SubType: Currency)		Line Item Freight Amount	See Currency
invoice.lineItems[].freightTaxAmount	number (SubType: Currency)		Line Item Freight Tax Amount	See Currency
invoice.lineItems[].freightTaxRate	number		Line Item Freight Tax Rate
businessApplication	string		Business Application	See Business Application
lodging.purchaseId	string (SubType: Alphanumeric)		Lodging Purchase Id
lodging.folio	string (SubType: Alphanumeric)		Lodging Folio (purchase identifier/hotel folio number)
lodging.customerServicePhone	string		Customer Service Phone
lodging.recordCharge	string (SubType: Alphanumeric)		Record Charge
lodging.propertyPhone	string		Property Phone
lodging.programCode	string (SubType: Alphanumeric)		Program Code
lodging.rooms[].checkIn	date-time		Lodging rooms Checkin
lodging.rooms[].checkOut	date-time		Lodging rooms Checkout
lodging.rooms[].authorizedAmount	number (SubType: Currency)		Lodging rooms Authorized Amount	See Currency
lodging.rooms[].duration	number		Lodging rooms duration	Integer between 0 and 99
funding	object		Funding
funding.tags	object		Funding Tags

Field Parameters

Alphanumeric

Defined as string fields, alphanumeric fields accept letters (A-Z, a-z), numbers (0-9), and spaces. This versatility supports a wide range of input data, including names and addresses.

Numeric

Numeric fields are string fields exclusively containing numbers (0-9). Ideal for data like phone numbers and identification numbers, ensuring data integrity through numeric-only input.

Currency

Currency fields are numerical and designed to represent monetary values, supporting up to two decimal places. This precision is crucial for accurate financial transactions and calculations.

Enumerations

Enumerations in our system are case-insensitive, offering flexibility in how values are submitted. You can input these values in any case format you prefer, simplifying data entry and reducing input errors.

Fields Overview

Transaction Type

Transaction Type	Description
Sale	A transaction where goods or services are purchased and payment is made by the cardholder.
Return	A transaction where the cardholder returns previously purchased goods or services, resulting in a refund.
Void	A transaction that cancels a previously authorized transaction before it is settled, effectively nullifying the original operation.
Reversal	A transaction that reverses a previously completed transaction, often used in error correction or dispute resolution.
Adjustment	A transaction that modifies the amount or terms of a previously authorized or completed transaction, typically for corrections or concessions.
Authorization	A request to confirm card validity and availability of funds for a transaction, temporarily holding the authorized amount.
SaleCompletion	The final step in processing a sale transaction, moving funds from the cardholder to the merchant after initial authorization.
AccountVerification	A transaction to verify that an account is active and valid, often with no actual transfer of funds.
CashAdvance	A transaction where the cardholder uses their credit card to withdraw cash, typically incurring high fees and interest rates.
Prepaid	Refers to transactions involving prepaid cards, where funds are loaded onto the card in advance of any purchases.
PaymentTransaction	A broad term for any transaction where a payment is made, encompassing sales, bill payments, and other transfers of funds.
Withdrawal	A transaction in which funds are taken out of an account, typically referring to cash withdrawals from an ATM or bank.
Balance	A transaction or inquiry to check the available balance in an account or on a prepaid card.
BillPayment	A transaction where the cardholder uses their account to pay a bill, transferring funds to the biller.

Card Form

Card Form	Description
Virtual	A non-physical card that exists digitally and is used for online transactions or within digital wallets.
Plastic	A traditional physical card made of plastic with a magnetic stripe and/or chip for transactions.
Mobile	A card stored on a mobile device, used through apps or mobile wallets for contactless payments or online purchases.
Tablet	A card stored on a tablet device, utilized similarly to mobile cards for conducting transactions through apps or digital wallets.

Network

Network	Description
MasterCard	A global payment network that processes transactions between merchants and card issuing banks, facilitating credit, debit, and prepaid transactions.
Visa	An international payment system that provides the technology for electronic fund transfers and payments, widely accepted worldwide.
Discover	A payment network primarily known in the United States, offering credit card, debit, and payment services.
AmericanExpress	A multinational financial services corporation that issues credit cards, processes payments, and provides travel-related services worldwide.

Capture Method

Capture Method	Description
Unknown	The capture method is not identified, typically due to incomplete transaction information.
Manual	The transaction details are entered manually, often used when the card is not present or the magnetic strip is unreadable.
Swipe	The card's magnetic stripe is swiped through a card reader, reading the card's data for transaction processing.
Chip	Utilizes EMV chip technology, where the card is inserted into a reader that communicates with the chip to complete the transaction.
ContactlessSwipe	A transaction method where the card is swiped near a reader without direct contact, typically using magnetic secure transmission (MST).
ContactlessChip	A secure transaction method using near-field communication (NFC) technology, where the card is tapped or held close to the reader.
Fallback	Used when a preferred transaction method fails (e.g., chip to magnetic stripe), allowing the transaction to be processed by an alternative method.
ContactlessMobile	Transactions made using a mobile device equipped with payment technology (e.g., Apple Pay, Google Wallet) to communicate with a reader.
OnFile	Payment information is stored by the merchant or service provider for recurring transactions, reducing the need for physical card details for each transaction.

PIN Capture Capability

PIN Capture Capability	Description
Unknown	The device's capability to capture a PIN is not known or has not been specified.
Capable	The device is fully functional and capable of securely capturing a cardholder's PIN during a transaction.
Incapable	The device does not have the functionality to capture a cardholder's PIN.
Inoperative	The PIN capture functionality of the device is currently not operational due to a fault or configuration issue.
Offline	The device can capture the PIN without needing an online connection to a payment processor for verification.
Four	The device is capable of capturing and processing PINs up to four digits in length.
Five	The device can capture and process PINs that are five digits long.
Six	The device supports the capture and processing of PINs up to six digits in length.
Seven	The device is equipped to handle PINs that are seven digits long for transaction processing.
Eight	The device can securely capture and process eight-digit PINs during transactions.
Nine	The device supports nine-digit PINs, indicating a high level of flexibility in PIN length acceptance.
Ten	The device is capable of handling PINs up to ten digits long, suitable for systems requiring extended PIN security.
Eleven	Indicates the device's ability to process eleven-digit PINs, catering to specific security requirements.
Twelve	The device can capture and process PINs that are up to twelve digits in length, offering the highest flexibility in PIN length.

Carholder Presence

Cardholder Presence	Description	Note
Unknown	The presence of the cardholder during the transaction is not identified.	Not supported for MasterCard.
Present	The cardholder physically presents the card for the transaction.
NotPresent	The cardholder is not physically present during the transaction.
Mail	The transaction is conducted via mail, with the cardholder providing card details through a mail order.
Phone	The transaction is conducted over the phone, with the cardholder verbally providing card details.
Standing	A transaction type that occurs on a regular basis under standing authorization, not needing the cardholder's presence each time.
Recurring	Regular payments for ongoing services or subscriptions, where card details are stored and charged periodically.
Ecom	Transactions are conducted online or through electronic commerce platforms, without physical card presentation.

Device Attendance

Device Attendance	Description	Note
Unknown	The status of the device used during the transaction is not identified or not provided.	Not supported for MasterCard.
Attended	The transaction is completed on a device that is supervised by personnel, such as a POS terminal in a store.
HomePc	The transaction is initiated from a personal computer located at the cardholder's home.
VoiceAru	The transaction is conducted through an automated response unit over the phone, often used for telephone banking or payments.
Recurring	The transaction is part of a set of transactions that occur on a regular basis, processed automatically.
Server	The transaction is processed through a server, typically in the context of online payments or transactions initiated through an app.
Unattended	The transaction is completed on a device without the need for personnel supervision, such as kiosks or automated fuel dispensers.

Merchant Business Type Values

Merchant Business Type	Description
Retail	Businesses that sell goods or services directly to the public, typically through physical stores.
Restaurant	Establishments that prepare and serve food and beverages to customers.
Moto	Mail Order/Telephone Order merchants, who take orders and payments over the phone or via mail.
Internet	Businesses that operate online, selling goods or services through websites or online platforms.
Lodging	Businesses that provide accommodations and services for travelers, such as hotels and motels.
Qsrqps	Quick Service Restaurants and Quick Payment Service providers, offering fast food and quick payment options.
Supermarket	Large retail market that sells food and household goods.
Petroleum	Businesses involved in the selling of gasoline and diesel fuel, often including convenience stores.
Other	A category for businesses that do not fit into the specified categories.
Utilities	Companies that provide public services such as water, electricity, natural gas, and sewage services.
Healthcare	Providers of medical services, equipment, and healthcare facilities.
Education	Institutions involved in the instruction or training of individuals, including schools, colleges, and universities.
Government	Entities that operate at the federal, state, or local level, providing public services and governance.
Charitynonprofit	Organizations that operate for charitable purposes, not for profit, often focusing on social, educational, or humanitarian objectives.
B2B	Business-to-Business transactions, where goods or services are sold from one business to another.
CashAdvance	Services that provide customers with a short-term cash loan against their credit card or line of credit.

Partial Approval Support

Partial Approval Support	Description
NotSupported	Indicates that the merchant or payment processor does not accept partial approvals. All transactions must be fully approved or declined.
Supported	Indicates that partial approvals are accepted, allowing transactions to be approved for a portion of the requested amount if full authorization is not possible.
MerchandiseOnly	Partial approvals are accepted only for merchandise purchases. This excludes services or cash-related transactions.
CashOnly	Partial approvals are only supported for transactions involving cash, such as cash back at a retail store.
Exclusive	Indicates a special or exclusive arrangement where partial approvals are handled differently than the standard practice, possibly with specific limitations or conditions.

Device Input Capability

Device Input Capability	Description	Note
Unknown	The method by which the device captures card data is not specified or is unknown.	Not supported for MasterCard.
VoiceAru	Card details are entered manually over the phone via an Automated Response Unit.
Swipe	The device captures card data through a magnetic stripe swipe.
ContactlessChip	The device supports transactions via contactless EMV chip technology.
ContactlessSwipe	The device allows card data capture through a contactless magnetic stripe data (MSD) transaction.
ChipSwipe	The device can process both chip (EMV) and magnetic stripe swipe transactions.
KeyedOnly	Card details are entered manually into the device, typically without the physical card.
SwipeKeyed	The device supports both magnetic stripe swipe and manual keyed entry of card details.
ChipSwipeKeyed	The device is capable of processing chip, swipe, and manual keyed entry transactions.
Chip	The device captures card data through an EMV chip reader.
Rfid	The device uses Radio-Frequency Identification (RFID) technology for transactions.	Discover only.
Hybrid	The device supports multiple input methods, possibly including chip, swipe, contactless, and RFID.	Discover only.
Mobile	Transactions are processed through a mobile device using its input capabilities.	Discover only.
MobileTap	The device supports transactions initiated by tapping a mobile device equipped with payment technology.	Discover only.
RfidSwipe	The device supports both RFID technology and magnetic stripe swipe for capturing card data.	Discover only.
SecureCertificate	Transactions are secured using a digital certificate for authentication.	Discover only.
SecureNonCertificate	The device uses secure methods for transactions that do not involve digital certificates.	Discover only.
SecureChannel	Transactions are conducted over a secure communication channel.	Discover only.
NonSecure	The device processes transactions without enhanced security features.	Discover only.
Server	Transactions are processed through a server, indicating a lack of direct input capability on the device itself.	Discover only.

CAT Level

CAT Level	Description
Unknown	The Cardholder Authentication Technology (CAT) level for the transaction is not specified or unknown.
None	No cardholder authentication technology is used in the transaction.
Ecom	The transaction utilizes electronic commerce (ecom) authentication technologies suitable for online transactions.
Unattended	The transaction is processed through an unattended terminal, which may include kiosks, fuel dispensers, or other self-service terminals.

Transaction Security

Transaction Security	Description
Normal	The transaction is processed under standard security measures without any additional flags for suspicion or enhanced verification.
FraudSuspected	The transaction has been flagged for potential fraudulent activity and may undergo further review or additional authentication.
IdVerified	The identity of the cardholder has been verified through document checks or other non-biometric means as part of the transaction process.
BiometricsVerified	The transaction includes biometric verification of the cardholder, such as fingerprint, facial recognition, or voice verification, enhancing security.

Shipping Methods

Note: MVV (Merchant Verification Value) is a specific requirement for certain transactions and must adhere to the regular expression /^[0-9a-fA-F]{10}$/.

It should only be utilized when explicitly assigned by Visa. This ensures compliance with Visa's requirements for secure transaction processing.

Shipping Methods	Description
sameDay	Delivery on the same day as the order is placed.
overNight	Delivery by the next day.
priority	Prioritized delivery service.
ground	Standard delivery service through ground transportation.
electronicDelivery	Digital delivery of products or services.
shipToStore	Delivery to a designated store for customer pickup.

Additional Types

Date-Time

Description: A string date in ISO 8601 format.
Format: YYYY-MM-DDTHH:mm:ssZ

Optionally Encrypted Fields

Description: Indicates that a field can be transmitted either in clear text following the specified type and restrictions, or as an encrypted object.
Specifications:
- Clear Text: Passed directly using the indicated type and restrictions.
- Encrypted Object:
  - key: The base 64 encoded serial number of the encryption key.
  - value: The base 64 encoded encrypted value of the field.