CardNumber | AN | Y | 13 | 19 | This is the credit card number with no spaces or hyphens. Not required if utilizing a previously created Save on File Payment Plan; otherwise, required if Track1Data or Track2Data is not present. | |
CardExpiration | AN | Y | 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, mm - yy, mm / yy, mm-yy or MM/YY. Not required if utilizing a previously created Save on File Payment Plan. | |
Amount | DEC | Y, must be greater than 0 | 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 | NUM | N | 3 | 4 | Used for Card Verification Services only. | |
CardHolderName | AN | N | 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 | | 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 | Not currently used. | |
InstallmentCount | NUM | N | 1 | 2 | Not currently used. | |
InstallmentSequence | NUM | N | 1 | 2 | Not currently used. | |
IsRecurring | AN | N | 4 | 5 | Not currently used. | |
IsSaveOnFile | AN | N | 4 | 5 | Not currently used. | |
SaveOnFileTransactionID | AN | C | 1 | 50 | Not currently used. | |
Patient | | 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. | |
PaymentPlanID | AN | N | 1 | 50 | Not currently used. | |
ReasonCode | AN | N | 1 | 50 | N/A for this transaction type. | |
ReasonText | AN | N | 1 | 400 | N/A for this transaction type. | |
InstaMedAccountID | AN | N | 1 | 100 | Not currently used. | |
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. | |