Field | Format | Required? | Min | Max | Comments |
---|---|---|---|---|---|
AuthNumber | AN | C | 20 | Conditionally required for capturing Voice Authorizations, Authorizations Only, Payment Plan Authorization and Save on File transactions. | |
CardNumber | AN | C, If Track1Data and Track2Data are not present, CardNumber is required | 13 | 19 | These are the credit card numbers with no spaces or hyphens, which are typically 13-16 digits in length. Acquiring software applications should validate card numbers using the Luhn's algorithm. Additionally, the first digit should match the card type:
Not required if utilizing a previously created Save on File Payment Plan; otherwise, required if Track1Data or Track2Data is not present. |
CardExpiration | AN | If Track1Data and Track2Data are not present, CardExpiration is required | 5 | 5 | This is the credit card’s expiration date, and it must be a valid date. Should be one of the following: MM-YY or MM/YY. Not required if utilizing a previously created Save on File Payment Plan. |
Amount | DEC | Y | 1 | 15 | The amount of money being authorized or charged to a credit or debit card, or the amount for which a check is written. Must be greater than 0. |
CardVerificationNumber | AN | N | 3 | 4 | Used for Card Verification Services only. |
CardHolderName | AN | C | 1 | 121 | Conditionally required based on outlet configuration. Consult your Implementations Manager for specific requirements that may apply. |
Track1Data | AN | If CardPresentStatus is PresentSwipeSign or PresentSwipeNoSign, either Track1Data or Track2Data is required | 1 | 79 | This is track 1 from the ISO/IEC standard 7811. Not required if utilizing a previously transacted Save on File transaction; otherwise, required if CardPresentStatus is swiped and Track2Data is not set. No more than 76 characters in length. |
Track2Data | AN | See Track1Data | 1 | 40 | This is track 2 from the ISO/IEC standard 7811. Not required if utilizing a previously transacted Save on File transaction; otherwise, required if CardPresentStatus is swiped and Track2Data is not set. No more than 76 characters in length. |
AddressVerificationInfo | See below fields | N | Complex element type. | ||
Street1 | AN | N | 1 | 150 | The primary street address associated with the card. |
Street2 | AN | N | 1 | 150 | Secondary street address associated with the card. |
Street3 | AN | N | 1 | 150 | |
City | AN | N | 1 | 50 | The city associated with the address of the card. |
State | AN | N | 1 | 2 | The state associated with the address of the card. |
Zip | AN | N | 1 | 15 | |
Country | AN | N | 1 | 30 | See Country Codes. |
Company | AN | N | 1 | 30 | |
CardPresentStatus | AN | Y | 1 | 50 | See Card Present Status Codes. Describes situations where the card data may or may not be present. When using TransactionID, use PresentManualKey, NotPresentInternet or NotPresentMailOrFax. |
MerchantID | AN | Y | 1 | 50 | The unique ID associated with your merchant processing account, which will be provided by your Implementations Manager. |
StoreID | AN | Y | 1 | 50 | See MerchantID comments. |
TerminalID | AN | Y | 1 | 50 | See MerchantID comments. |
TransactionID | AN | N | 1 | 50 | The transaction ID number is only used in the response and is set by InstaMed. |
TransactionNumber | AN | N | 1 | 50 | The transaction number may be passed in or is set by InstaMed. |
BatchID | AN | N | 1 | 20 | Not currently used. |
IsInstallment | AN | N | 4 | 5 | “True” or “false.” Default is “false.” Used only in such cases where the Installment Payment Plan is managed in the source system ( i.e., not on the InstaMed Platform ). |
InstallmentCount | NUM | N | 1 | 2 | Total number of payments in Installment Plan. Used only in such cases where the Installment Payment Plan is managed in the source system ( i.e., not on the InstaMed Platform ). |
InstallmentSequence | NUM | N | 1 | 2 | Current payment in Installment Plan. Used only in such cases where the Installment Payment Plan is managed in the source system ( i.e., not on the InstaMed Platform ). |
IsRecurring | AN | N | 4 | 5 | “True” or “false.” Default is “false.” Used only in such cases where the Installment Payment Plan is managed in the source system ( i.e., not on the InstaMed Platform ). |
IsSaveOnFile | AN | N | 4 | 5 | Not currently used. |
SaveOnFileTransactionID | AN | C | 1 | 50 | Only required if utilizing a previously transacted Save on File transaction. |
PaymentMethodID | AN | C | 1 | 50 | |
Patient | See below fields | N | Complex element type. | ||
PatientID | AN | N | 1 | 50 | A unique identifier for the patient, which is typically sourced from the Patient Accounting System. |
PatientFirstName | AN | N | 1 | 50 | |
PatientLastName | AN | N | 1 | 50 | |
PatientMiddleName | AN | N | 1 | 50 | |
AdditionalInfo1 | AN | N | 1 | 100 | User-defined fields to be captured with the payment transaction. |
AdditionalInfo2 | AN | N | 1 | 100 | See AdditionalInfo1 comments. |
AdditionalInfo3 | AN | N | 1 | 100 | See AdditionalInfo1 comments. |
AdditionalInfo4 | AN | N | 1 | 100 | See AdditionalInfo1 comments. |
AdditionalInfo5 | AN | N | 1 | 100 | See AdditionalInfo1 comments. |
AdditionalInfo6 | AN | N | 1 | 100 | See AdditionalInfo1 comments. |
PurchaseIdentifier | AN | N | Not currently used. | ||
CardType | AN | N | 1 | 35 | Supported values: "VISA,” "MASTERCARD,” "AMEX,” "DISCOVER." |
CardHolderEmail | AN | C | 1 | 100 | Conditionally required based on outlet configuration. Consult your Implementations Manager for specific requirements that may apply. |
CardHolderFirstName | AN | C | 1 | 60 | Conditionally required based on outlet configuration. Consult your Implementations Manager for whether these fields are supported for your implementation. |
CardHolderLastName | AN | C | 1 | 60 | Conditionally required based on outlet configuration. Consult your Implementations Manager for whether these fields are supported for your implementation. |
Transaction Code | AN | O | 1 | 30 | Note : Please submit the Transaction Code rather than description. Consult your Implementations Manager to configure Transaction Codes on your account. |
Track3Data | AN | O | 1 | 82 | |
EncryptedTrack1Data | AN | O | 1 | * | Output by encrypted card reader. |
EncryptedTrack2Data | AN | O | 1 | * | Output by encrypted card reader. |
EncryptedTrack3Data | AN | O | 1 | * | Output by encrypted card reader. |
DUKPTKSN | AN | O | 1 | * | Output by encrypted card reader. |
PrintStatus | AN | O | 1 | * | Output by encrypted card reader. |
PrintData | AN | O | 1 | * | ISO output by encrypted card reader. |
CardEncodeType | AN | O | 1 | * | ISO output by encrypted card reader. |
CombinedCardData | AN | O | 1 | 300 | Output by card reader. |
hasEncryptedCardData | AN | B | 4 | 5 | True or false. |
CombinedCardDataEncrypted* | AN | O | 1 | 2400 | ISO output by encrypted card reader. |
encryptedEMVData | AN (Hex) | C | 1 | 5000 | |
deviceName | AN & P | C | 1 | 100 | |
deviceSerialNumber | AN (Hex) | C | 1 | 50 | |
encrypted-cardNumber | AN | C | 1 | 2000 | Encrypted block from client-side encryption library call on card number. |
encrypted-expDate | AN | C | 1 | 2000 | Encrypted block from client-side encryption library call on expiration date. |
encrypted-cvn | AN | C | 1 | 2000 | Encrypted block from client-side encryption library call on CVN. |
encryptedNFCdata | AN | C | 1 | 2000 | |
applePayMerchantID | AN | C | 1 | 2000 | |
applePayTokenData | AN | C | 1 | 2000 |