Field | Format | Required? | Min | Max | Comments |
---|---|---|---|---|---|
MerchantID | AN | Y | 0 | 50 | |
StoreID | AN | Y | 0 | 50 | |
TerminalID | AN | Y | 0 | 50 | |
PaymentPlanTransactionType | AN | Y | 0 | 50 | Credit card or eCheck. |
IsRecurring | B | N | 0 | 5 | True or false. |
isSaveOnFile | B | N | 0 | 5 | True or false. |
IsInstallment | B | N | 0 | 5 | True or false. |
Credit Card Payment Plans | |||||
CardType | AN | N | 1 | 10 | VISA, MC, AMEX, DISC – we can determine this based on the Card Number. |
CardHolderName | AN | C | 1 | 121 | Conditionally required based on outlet configuration. Consult your Implementations Manager for specific requirements that may apply. |
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. | |||||
CardVerificationNumber | AN | N | 3 | 4 | Used for Card Verification Services only. |
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. |
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. |
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. |
AllowCardExpirationDateBeforeEndDate | |||||
eCheck Payment Plans | |||||
AccountNumber | AN | Y | 1 | 30 | The account number ( with dashes “-’’ ) for the account from which a check is drawn. |
RoutingNumber | AN | Y | 1 | 9 | The routing number for the bank from which a check is drawn. |
AccountType | AN | Y | 1 | 20 | The type of account for which a check is drawn against. "Checking,” "Savings." |
CheckHolderFirstName | AN | If not IsBusinessECheck or it is for a WEBTEL transaction, CheckHolderFirstName is required | 1 | 25 | The first name of the checking account holder. |
CheckHolderLastName | AN | If not IsBusinessECheck or it is for a WEBTEL transaction, CheckHolderLastName is required | 1 | 25 | The last name of the checking account holder. |
MarketSegment | AN | 1 | 50 | See Market Segment Codes. | |
MICRData | AN | N | 1 | 50 | Magnetic ink character recognition data. This is the data printed at the bottom of the check. Format: “TOAD”
|
EPCField | AN | N | 1 | 10 | If not populated, this is automatically determined based on the MICRData. |
CustomerDLLNumber | AN | N | 1 | 50 | Customer’s driver’s license number. |
CustomerPhoneNumber | AN | N | 7 | 7 | Customer’s phone number. |
CheckState | |||||
ImageData | BYTE ARRAY | N | Payment Plan eCheck is PPD and images are not required. | ||
ImageFormat | C | Image/tiff, required if ImageData is populated. | |||
NumPages | NUM | C | Required if ImageData is populated. | ||
StartDate | DT | Y | 10 | 10 | Ex: 10/10/2012 |
EndDate | DT | Y | 10 | 10 | |
PaymentAmount | DEC | Y | |||
TotalAmountDue | DEC | Required if Installment | 1 | 15 | |
NumberOfPayments | DEC | No, we will calculate this if it is not given | 1 | 15 | |
Frequency | AN | Y | 1 | 50 | D – Daily W – Weekly T – Twice Monthly M – Monthly Q – Quarterly A – Annually4 W – Every 4 Weeks |
AccountHolderEmail | AN | N | |||
AccountHolderPhone | NUM | ||||
AddressVerificationInfo | |||||
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 | |
PatientAddressInfo | |||||
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 | |
AdditionalInfo1 | AN | N | 1 | 100 | |
AdditionalInfo2 | AN | N | 1 | 100 | |
AdditionalInfo3 | AN | N | 1 | 100 | |
AdditionalInfo4 | AN | N | 1 | 100 | |
AdditionalInfo5 | AN | N | 1 | 100 | |
AdditionalInfo6 | AN | N | 1 | 100 | |
Patient | |||||
PatientFirstName | AN | N | 1 | 50 | |
PatientMiddleName | AN | N | 1 | 50 | |
PatientLastName | AN | N | 1 | 50 | |
PatientID | AN | N | |||
EstimatedAmount | DEC | N | 1 | 15 | |
PatientID | AN | N | |||
PatientMedicalRecordNumber | AN | N | 1 | 100 | |
PatientPhoneNumber* | Phone | N | |||
PatientBirthDate | DT | N | 10 | 10 | |
PatientServiceBeginDate | DT | N | 10 | 10 | |
PatientServiceEndDate | DT | N | 10 | 10 | |
AdditionalCode1 | AN | N | 1 | 50 | |
AdditionalCode2 | AN | N | 1 | 50 | |
AdditionalCode3 | AN | N | 1 | 50 | |
AdditionalCode4 | AN | N | 1 | 50 | |
AdditionalCode5 | AN | N | 1 | 50 | |
AdditionalCode6 | AN | N | 1 | 50 | |
TimeZoneOffSetInMinutes | NUM | N | 1 | 8 | TimeZone offset, Example – 420 for PST. |
SaveOnFileTransactionID | AN | N | 1 | 50 | A valid Save on File transaction ID that was previously submitted via CreditCardSaveOnFile, etc. |