Webhook Integration Fields - InstaMed Developer Portal

Fields	Format	Required?	Min	Max	Comments
AccountHolderAddress1	AN	N	1	55	The primary street address associated with the accountholder or guarantor.
AccountHolderAddress2	AN	N	1	55	The street address second line associated with the accountholder or guarantor.
AccountHolderCity	AN	N	1	30	The city associated with the accountholder or guarantor.
AccountHolderCountry	AN	N	1	50	See Country Codes.
AccountHolderEmail	AN	N	1	200	Consult your Implementations Manager for specific requirements that may apply.
AccountHolderPhoneNumber	AN	N	1	8	Account holder (i.e., billing) phone number.
AccountHolderState	AN	N	1	2	The state associated with the accountholder or guarantor.
AccountHolderZip	AN	N	5	7	The postal code associated with the accountholder or guarantor.
AccountNumberLastFourDigits	AN	N	4	4	Last 4 digits of bank account number
AdditionalCode1	AN	N	1	50	User-defined All Codes and Info values passed in original transaction post will also be passed in secondary transaction posts (Voids and Simple Refunds). Installment and Recurring Payment Plan transactions will also pass Code and Info values included in Payment Plan configurations and updates for all subsequent payments.
AdditionalCode1Description	AN	N	1	100
AdditionalCode2	AN	N	1	50	All Codes and Info values passed in original transaction post will also be passed in secondary transaction posts (Voids and Simple Refunds). Installment and Recurring Payment Plan transactions will also pass Code and Info values included in Payment Plan configurations and updates for all subsequent payments.
AdditionalCode2Description	AN	N	1	100
AdditionalCode3	AN	N	1	50	All Codes and Info values passed in original transaction post will also be passed in secondary transaction posts (Voids and Simple Refunds). Installment and Recurring Payment Plan transactions will also pass Code and Info values included in Payment Plan configurations and updates for all subsequent payments.
AdditionalCode3Description	AN	N	1	100
AdditionalCode4	AN	N	1	50	All Codes and Info values passed in original transaction post will also be passed in secondary transaction posts (Voids and Simple Refunds). Installment and Recurring Payment Plan transactions will also pass Code and Info values included in Payment Plan configurations and updates for all subsequent payments.
AdditionalCode4Description	AN	N	1	100
AdditionalCode5	AN	N	1	50	All Codes and Info values passed in original transaction post will also be passed in secondary transaction posts (Voids and Simple Refunds). Installment and Recurring Payment Plan transactions will also pass Code and Info values included in Payment Plan configurations and updates for all subsequent payments.
AdditionalCode5Description	AN	N	1	100
AdditionalCode6	AN	N	1	50	All Codes and Info values passed in original transaction post will also be passed in secondary transaction posts (Voids and Simple Refunds). Installment and Recurring Payment Plan transactions will also pass Code and Info values included in Payment Plan configurations and updates for all subsequent payments.
AdditionalCode6Description	AN	N	1	100
AdditionalInfo1	AN	N	1	100	User-defined fields to be captured with the payment transaction. All Codes and Info values passed in original transaction post will also be passed in secondary transaction posts (Voids and Simple Refunds). Installment and Recurring Payment Plan transactions will also pass Code and Info values included in Payment Plan configurations and updates for all subsequent payments.
AdditionalInfo2	AN	N	1	100	User-defined fields to be captured with the payment transaction. All Codes and Info values passed in original transaction post will also be passed in secondary transaction posts (Voids and Simple Refunds). Installment and Recurring Payment Plan transactions will also pass Code and Info values included in Payment Plan configurations and updates for all subsequent payments.
AdditionalInfo3	AN	N	1	100	User-defined fields to be captured with the payment transaction. All Codes and Info values passed in original transaction post will also be passed in secondary transaction posts (Voids and Simple Refunds). Installment and Recurring Payment Plan transactions will also pass Code and Info values included in Payment Plan configurations and updates for all subsequent payments.
AdditionalInfo4	AN	N	1	100	User-defined fields to be captured with the payment transaction. All Codes and Info values passed in original transaction post will also be passed in secondary transaction posts (Voids and Simple Refunds). Installment and Recurring Payment Plan transactions will also pass Code and Info values included in Payment Plan configurations and updates for all subsequent payments.
AdditionalInfo5	AN	N	1	100	User-defined fields to be captured with the payment transaction. All Codes and Info values passed in original transaction post will also be passed in secondary transaction posts (Voids and Simple Refunds). Installment and Recurring Payment Plan transactions will also pass Code and Info values included in Payment Plan configurations and updates for all subsequent payments.
AdditionalInfo6	AN	N	1	100	User-defined fields to be captured with the payment transaction. All Codes and Info values passed in original transaction post will also be passed in secondary transaction posts (Voids and Simple Refunds). Installment and Recurring Payment Plan transactions will also pass Code and Info values included in Payment Plan configurations and updates for all subsequent payments.
AddressVerificationResponseCode	AN	N	1	50	See Address Verification Response Codes.
AddressVerificationResponseDescription	AN	N	1	150
Alias	AN	Y	1	100	InstaMed Payment ID (Alias) assigned during implementation. Also referred to as id in SSO request fields
Amount	DEC	N	1	10	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.
AuthorizationCode	AN	N	1	50	Primary identifier returned by the financial networks. Typically an important reference number
AuthorizationText	AN	N	1	*	Authorization text that can be displayed on the receipt
CardHolderFirstName	AN	C	1	100	Conditionally required based on outlet configuration. Consult your Implementations Manager for specific requirements that may apply.
CardHolderLastName	AN	C	1	60	Conditionally required based on outlet configuration. Consult your Implementations Manager for specific requirements that may apply.
CardHolderName	AN	N	1	121	Conditionally required based on outlet configuration. Consult your Implementations Manager for specific requirements that may apply.
CardInputMode	AN	N	1	10	Swipe, Tap, Insert, Manual
CardLastFourDigits	AN	N	16	16	Credit Card Number with first 12 digits masked. Only last 4 digits show.
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.
CardType	AN	N	1	10	Supported values: "VISA, "MASTERCARD," "AMEX, "DISCOVER."
CardVerificationResponseCode	AN	N	1	10	See Card Verification Response Codes.
CardVerificationResponseDescription	AN	N	1	100
CheckingAccountHolderFirstName	AN	C	1	50
CheckingAccountHolderLastName	AN	C	1	50
CheckingAccountType	AN	N	1	10	Checking we assume checking currently
CheckNumber	AN	N	1	50	The number of the check.
CheckState	AN	N	2	2	State that was entered on the transaction. This drives the TransacctionServiceFee.
CurrentTransactionStatusCode	AN	Y	1	10	Possible values: C = Approved V = Voided CB = charge back RI = Returns SE = Settlement Error S = Settled D = Declined O = Save On File
CurrentTransactionStatusDescription	AN	N	1	100
DriversLicense	AN	N	1	10	If the eCheck transaction had a drivers license entered, this is populated.
EstimatedAmount	DEC	N	1	15
EstimateID	AN	N	32	32	If the payment was made on an estimate, this is populated.
ExpDate	DT	C	6	10
FreeFormTextResponse	AN	N	1	100	Response from the processor for webtel transactions for declines, etc.
HasCheckImage	B	N	2	2	True if the eCheck transaction has an image.
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).
InstallmentSequenceNumber	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).
IsMultiAR	B	N	2	2	is true if this was a multi AR transaction
IsPartiallyApproved	B	N	2	2	is true if the payment was partially approved
LineItemNumber	NUM	N	1	3	if multi AR, this is the line item number
MarketSegment	AN	N	1	50	See Market Segment Codes.
MerchantID	AN	Y	1	50	The unique ID associated with your merchant processing account, which will be given by your Implementations Manager.
OriginalTransactionID	AN	Y	32	32	This is a unique ID assigned by InstaMed to the original transaction. E.g., "3c4fabfad61e47e4aa10b52529476529"
OriginalTransactionStatusCode	AN	Y	1	10	Possible values: C = Approved V = Voided CB = charge back RI = Returns SE = Settlement Error S = Settled D = Declined O = Save On File
OriginalTransactionStatusDescription	AN	N	1	100
Outlet	AN	N	1	50	Format MerchantID-StoreID-TerminalID
PartialApprovalAmount	D	N	1	10	Partially approved amount returned by the financial network
PatientAddress1	AN	N	1	55	Street address line 1 for the patient, which may be different than the guarantor address.
PatientAddress2	AN	N	1	55	Street address line 2 for the patient, which may be different than the guarantor address.
PatientBirthDate	DT	N	8	8
PatientCity	AN	N	1	30	City for the patient, which may be different than the guarantor address.
PatientCountry	AN	N	1	50	See Country Codes.
PatientFirstName	AN	N	1	35	Also referred to as consumerLastName
PatientID	AN	N	1	50	Also, referred to as consumerID. A unique identifier for the patient, populate using UMI.
PatientLastName	AN	N	1	35	Also referred to as consumerLastName
PatientMedicalRecordNumber	AN	N	1	100
PatientMiddleName	AN	N	1	25	Also referred to as consumerMiddleName
PatientPhoneNumber	AN	N	1	8
PatientServiceBeginDate	DT	N	10	10
PatientServiceEndDate	DT	N	10	10
PatientState	AN	N	2	2
PatientZip	AN	N	7	7
Payment MethodID	AN	N	1	50	Used when tracking saved payment methods
PaymentPlanID	AN	N	1	50	Populated for payment plan payment transactions
PaymentTransactionID	AN	Y	32	32	This is a unique ID assigned by InstaMed. E.g., "3c4fabfad61e47e4aa10b52529476529"
ReasonCode	AN	N	1	50
ReasonCodeDescription	AN	N	1	400
RequestAmount	DEC	Y	1	10
ResponseCode	AN	N	1	10	See Yes/No Condition or Response Code
ResponseDateTime	DT	N	19	23
ResponseMessage	AN	N	1	100
RoutingNumber	AN	C	1	9	The routing number for the bank from which a check is drawn. Required in eCheck transaction.
SaveBankAccountOnFile	B	N	2	2	indicates whether Save Bank On File was checked
SaveCardOnFile	B	N	2	2	indicates whether Save Card On file was checked
SaveOnFileTransactionID	AN	Y	32	32	This is a unique ID assigned by InstaMed for the SaveOnFile. E.g., "3c4fabfad61e47e4aa10b52529476529"
SingleSignOnToken	AN	C	1	20	If SSO was used, this will be the SSO token
StatementID	AN	Y	32	32	If a payment was originated from a statement, this is the statement ID of that statement
StoreID	AN	Y	1	50	Default value is 1.
TerminalID	AN	Y	1	50	May differ by location to enhance security and reporting.
TransactionAction	AN	Y	1	35	Possible values: Sale Chargeback Return Refund
TransactionCode	AN	N	1	50	All Codes and Info values passed in original transaction post will also be passed in secondary transaction posts (Voids and Simple Refunds). Installment and Recurring Payment Plan transactions will also pass Code and Info values included in Payment Plan configurations and updates for all subsequent payments.
TransactionDescription	AN	N	1	100
TransactionServiceFee	DEC	N	1	15	Used for echeck for the NSF Fee (insufficient funds fee) if an NSF were to occur
TransactionType	AN	O	1	100	Possible values: Credit card eCheck
UserID	AN	Y	1	200	Consumer user ID. Unique field that identify the consumer. This will be populated using member ID (UMI)
WorkflowStatus	AN	N	1	20	Populated with the payment's workflow status. Workflow statuses can be configured by the customer.

Build a better healthcare payments experience with InstaMed