For AI agents: the complete documentation index is at /llms.txt, and the full text of every page is at /llms-full.txt. Most pages are also available as Markdown by adding .md to the URL.

Loading...

Data Structures

MerchantCredentials

Name	Type	Size	Description
MerchantName	String	1-160	The name of the business or organization owning the Merchantware account.
MerchantSiteId	String	8-160	The site identifier of a location or storefront owned by the Merchantware account owner.
MerchantKey	String	1-160	The software key or password for the site accessing a Merchantware account.

CheckData

Name	Type	Size	Source	Description
Source	String	1-19	ALL	The method you use to process the transaction, which includes:• KEYED • READER • PREVIOUSTRANSACTION • VAULTFor the parameters to include for each Source type, see Source.
VerificationMethod	String	1-21	KEYED, READER, PREVIOUSTRANSACTION	The method for verifying the customer. See Verification methods.
Token	String	1-100	PREVIOUSTRANSACTION	The token representing a transaction you previously ran. Use this only for Refund transactions to refer to the original transaction that you are refunding. Note: This is only used when performing a refund indicate refund by reference.
VaultToken	String	1-20	VAULT	A token for a specific checking account that the merchant boarded to the vault. If you send both CheckData and VaultToken in the request, Merchantware ignores CheckData and uses the CheckData referenced by the VaultToken. Note: To use the VaultToken, make sure the source is "VAULT".
Check	CheckInformation	-	-	The Check object contains fields that describe the check.
PersonalData	PersonalDataInformation	-	-	The checkholder's personal information.
HomeAddress	HomeAddressInformation	-	-	The checkholder's home address.
DriverLicense	DriverLicenseInformation	-	-	The checkholder's driver license information.

CheckInformation

Name	Type	Size	Source	Description
AccountType	String	1	KEYED + READER	The type of account the customer is using for the transaction. Verify against the Account Type codes.
CheckType	String	2	KEYED + READER	The type of check or checking account. Verify against the Check Type codes.
NameOnCheck	String	0-160	KEYED + READER	The customer's name that appears on the check. Note: You must send the customer's name in the format "FirstName SecondName" for check types that are "PE".
Amount	String (Double)	1-100	KEYED, READER, VAULT	The dollar amount of the transaction.
TransitNumber	String	0 - 9	KEYED	The nine digit transit routing number. Note: Merchantware masks all digits except the last four in responses.
AccountNumber	String	0-18	KEYED	The number of the customer's bank account. Note: Merchantware masks all digits except the last four in responses.
CheckNumber	String	0-6	KEYED	The number of the check. Do not send this parameter for recurring check transactions.
MICR	String	0-100	READER	The raw Magnetic Ink Character Recognition (MICR) data. Note: You should keep the substitution for the check symbols and spaces:• The Transit symbol is replaced with an uppercase or lowercase 'T'. • The On-US symbol is replaced with an uppercase or lowercase 'O'. • The Amount symbol is replaced with an uppercase or lowercase 'A'. • The Dash symbol is replaced with an uppercase or lowercase 'D'.

PersonalDataInformation

Name	Type	Size	Source	Description
PhoneNumber	String	0-10	KEYED, READER, PREVIOUSTRANSACTION	The consumer’s contact phone number. The phone number is expected as a 10 digit number without a – or ().
DateOfBirth	String	0-8	KEYED, READER, PREVIOUSTRANSACTION	The customer's date of birth in MMDDYYYY format.
SocialSecurityNumber	String	0-9	KEYED, READER, PREVIOUSTRANSACTION	The customer's Social Security number.

HomeAddressInformation

Name	Type	Size	Source	Description
StreetAddress1	String	0-200	KEYED, READER, PREVIOUSTRANSACTION	The first line of the customer's address.
StreetAddress2	String	0-200	KEYED, READER, PREVIOUSTRANSACTION	The second line of the customer's address.
City	String	0-50	KEYED, READER, PREVIOUSTRANSACTION	The city of the customer's address.
State	String	0-2	KEYED, READER, PREVIOUSTRANSACTION	A code representing the state or province of the customer's address. For a list of codes you can use, see:• [US States](https://developer.globalpaymentsintegrated.com/#/landing/content/%2Fportal%2Fweb%2Fapi%2Fgenius-merchantware%2Fcheck?top=Genius%20API&amp;l1=Genius%20MerchantWare&amp;l2=Check#US\_States) • [Canadian Provinces and Territories](https://developer.globalpaymentsintegrated.com/#/landing/content/%2Fportal%2Fweb%2Fapi%2Fgenius-merchantware%2Fcheck?top=Genius%20API&amp;l1=Genius%20MerchantWare&amp;l2=Check#Canadian\_Provinces\_and\_Territories) • [ID Types](https://developer.globalpaymentsintegrated.com/#/landing/content/%2Fportal%2Fweb%2Fapi%2Fgenius-merchantware%2Fcheck?top=Genius%20API&amp;l1=Genius%20MerchantWare&amp;l2=Check#ID\_Types)
ZipCode	String	0-5

DriverLicenseInformation

Name	Type	Size	Source	Description
Number	String	0-33	KEYED, READER, PREVIOUSTRANSACTION	The number of the driver's license.
State	String	0-2	KEYED, READER, PREVIOUSTRANSACTION	A code representing the state or province of the customer's address on the driver's license. For a list of codes you can use, see:• [US States](https://developer.globalpaymentsintegrated.com/#/landing/content/%2Fportal%2Fweb%2Fapi%2Fgenius-merchantware%2Fcheck?top=Genius%20API&amp;l1=Genius%20MerchantWare&amp;l2=Check#US\_States) • [Canadian Provinces and Territories](https://developer.globalpaymentsintegrated.com/#/landing/content/%2Fportal%2Fweb%2Fapi%2Fgenius-merchantware%2Fcheck?top=Genius%20API&amp;l1=Genius%20MerchantWare&amp;l2=Check#Canadian\_Provinces\_and\_Territories) • [ID Types](https://developer.globalpaymentsintegrated.com/#/landing/content/%2Fportal%2Fweb%2Fapi%2Fgenius-merchantware%2Fcheck?top=Genius%20API&amp;l1=Genius%20MerchantWare&amp;l2=Check#ID\_Types)
CourtesyCardNumber	String	0-50	KEYED, READER, PREVIOUSTRANSACTION	A number the merchant assigns to the customer if they do not have a driver's license.

VerificationRequest

Name	Type	Size	Description
RegisterNumber	String	0-10	The identifier for the register or point of sale device submitting the transaction.
MerchantTransactionId	String	0-100	The merchant-defined identifier for the transaction.
InvoiceNumber	String	0-8	The invoice or order number associated with the transaction.
CustomerCode	String	0-100	The merchant-defined identifier for the customer involved in the transaction.
PurchaseOrderNumber	String	0-100	The customer-defined identifier declaring a purchase order for the transaction.
CheckImages	CheckImagesInformation	-	Image data for the front and back of the check.

CheckImagesInformation

Name	Type	Size	Description
Front	Base64 String	Preferably under 100kb, max size of 150kb.	Contains the image data for the check front. The image:• Either tiff or png; • Dimensions of 800 X 600 • Resolution of 200dpi • Color depth of one bit (black and white); • base64 encrypted
Back	Base64 String	Preferably under 100kb, max size of 150kb.	Contains the image data for the check back. The image:• Either tiff or png; • Dimensions of 800 X 600 • Resolution of 200dpi • Color depth of one bit (black and white); • base64 encrypted

ForceAuthorizationRequest

Name	Type	Size	Description
RegisterNumber	String	0-10	The identifier for the register or point of sale device submitting the transaction.
MerchantTransactionId	String	0-100	The merchant-defined identifier for the transaction.
InvoiceNumber	String	0-8	The invoice or order number associated with the transaction.
CustomerCode	String	0-100	The merchant-defined identifier for the customer involved in the transaction.
PurchaseOrderNumber	String	0-100	The customer-defined identifier declaring a purchase order for the transaction.
Token	String	1-100	Allow for a reference to a previous transaction to be submitted and refund, force or void to take place.

AuthorizationRequest

Name	Type	Size	Description
RegisterNumber	String	0-10	The identifier for the register or point of sale device submitting the transaction.
MerchantTransactionId	String	0-100	The merchant-defined identifier for the transaction.
InvoiceNumber	String	0-8	The invoice or order number associated with the transaction.
CustomerCode	String	0-100	The merchant-defined identifier for the customer involved in the transaction.
PurchaseOrderNumber	String	0-100	The customer-defined identifier declaring a purchase order for the transaction.
RecurringCheck	String (Boolean)	0-5	Contains an indicator to the transaction being recurring. A transaction cannot be forced when it's recurring and cannot be have a payroll check type.
CheckImages	CheckImagesInformation	-	Image data for the front and back of the check.

VoidRequest

Name	Type	Size	Description
Token	String	1-100	Allow for a reference to a previous transaction to be submitted and refund, force or void to take place.
RegisterNumber	String	0-10	The identifier for the register or point of sale device submitting the transaction.
MerchantTransactionId	String	0-100	The merchant-defined identifier for the transaction.

RefundRequest

Name	Type	Size	Description
RegisterNumber	String	0-10	The identifier for the register or point of sale device submitting the transaction.
MerchantTransactionId	String	0-100	The merchant-defined identifier for the transaction.
InvoiceNumber	String	0-8	The invoice or order number associated with the transaction.
CustomerCode	String	0-100	The merchant-defined identifier for the customer involved in the transaction.
PurchaseOrderNumber	String	0-100	The customer-defined identifier declaring a purchase order for the transaction.
CheckImages	CheckImagesInformation	-	Image data for the front and back of the check.

CheckTransactionResponse46

Name	Type	Source	Description
ActionDescription	String	ALL	Any action message indicated by the verifier. If populated this value should be displayed to the cashier.
ApprovalStatus	String	ALL	The status of the transaction, whether approved or declined. This value may also have other definitions depending on context.
AuthorizationCode	String	ALL	Authorization Code issued by the processor upon receipt of a transaction.
ErrorMessage	String	ALL	A message describing the reason the transaction could not complete.
Token	String	ALL	The identifier received by the Merchantware client when a transaction has been issued. This value may be used to lookup a specific transaction in the history log.
CheckData	CheckDataResponse	KEYED, READER, VAULT	An object containing data about the check.
RecurringCheck	String	KEYED, READER, VAULT	Indicates if the transaction is recurring. The value is either:• True - the transaction is recurring • False - the transaction is not recurring
MerchantTransactionId	String	KEYED, READER, VAULT	The identifier that the merchant gave the transaction.
MerchantVaultTokenReference	String	VAULT	A parameter that a merchant can use to add a tag to a customer's account. The merchant can add the same tag to many accounts so that they can group transactions.

CheckDataResponse

Name	Type	Size	Description
Source	String	1-100	The method you use to process the transaction, which includes:• KEYED • READER • PREVIOUSTRANSACTION • VAULTFor the parameters to include for each Source type, see Source.
VerificationMethod	String		The method for verifying the customer. See Verification methods.
Token	String	1-100	The token representing a transaction you previously ran. Use this only for Refund transactions to refer to the original transaction that you are refunding. Note: This is only used when performing a refund indicate refund by reference.
VaultToken	String	1-20	A token for a specific checking account that the merchant boarded to the vault. If you send both CheckData and VaultToken in the request, Merchantware ignores CheckData and uses the CheckData referenced by the VaultToken. Note: To use the VaultToken, make sure the source is "VAULT".
Check	CheckInformationResponse	-	The Check object contains fields that describe the check.
PersonalData	PersonalDataInformationResponse	-	The checkholder's personal information.
HomeAddress	HomeAddressInformationResponse	-	The checkholder's home address.
DriverLicense	DriverLicenseInformationResponse

CheckInformationResponse

Name	Type	Size	Description
AccountType	String	1	The type of account the customer is using for the transaction. Verify against the Account Type codes.
CheckType	String	2	The type of check or checking account. Verify against the Check Type codes.
NameOnCheck	String	0-160	The customer's name that appears on the check. Note: You must send the customer's name in the format "FirstName SecondName" for check types that are "PE".
Amount	String (Double)	1-100	The dollar amount of the transaction.
TransitNumber	String	0 - 9	The nine digit transit routing number. Note: Merchantware masks all digits except the last four in responses.
AccountNumber	String	0-18	The number of the customer's bank account. Note: Merchantware masks all digits except the last four in responses.
CheckNumber	String	0-6	The number of the check. Do not send this parameter for recurring check transactions.
MICR	String	0-100	The raw Magnetic Ink Character Recognition (MICR) data. Note: You should keep the substitution for the check symbols and spaces:• The Transit symbol is replaced with an uppercase or lowercase 'T'. • The On-US symbol is replaced with an uppercase or lowercase 'O'. • The Amount symbol is replaced with an uppercase or lowercase 'A'. • The Dash symbol is replaced with an uppercase or lowercase 'D'.

PersonalDataInformationResponse

Name	Type	Size	Description
PhoneNumber	String	0-10	The consumer’s contact phone number. The phone number is expected as a 10 digit number without a – or ().
DateOfBirth	String	0-8	The customer's date of birth in MMDDYYYY format.
SocialSecurityNumber	String	0-9	The customer's Social Security number.

HomeAddressInformationResponse

Name	Type	Size	Description
StreetAddress1	String	0-200	The first line of the customer's address.
StreetAddress2	String	0-200	The second line of the customer's address.
City	String	0-50	The city of the customer's address.
State	String	0-2	A code representing the state or province of the customer's address. For a list of codes you can use, see:• [US States](https://developer.globalpaymentsintegrated.com/#/landing/content/%2Fportal%2Fweb%2Fapi%2Fgenius-merchantware%2Fcheck?top=Genius%20API&amp;l1=Genius%20MerchantWare&amp;l2=Check#US\_States) • [Canadian Provinces and Territories](https://developer.globalpaymentsintegrated.com/#/landing/content/%2Fportal%2Fweb%2Fapi%2Fgenius-merchantware%2Fcheck?top=Genius%20API&amp;l1=Genius%20MerchantWare&amp;l2=Check#Canadian\_Provinces\_and\_Territories) • [ID Types](https://developer.globalpaymentsintegrated.com/#/landing/content/%2Fportal%2Fweb%2Fapi%2Fgenius-merchantware%2Fcheck?top=Genius%20API&amp;l1=Genius%20MerchantWare&amp;l2=Check#ID\_Types)
ZipCode	String	0-5	The ZIP code of the customer's address.

DriverLicenseInformationResponse

Name	Type	Size	Description
Number	String	0-33	The number of the driver's license.
State	String	0-2	A code representing the state or province of the customer's address on the driver's license. For a list of codes you can use, see:• [US States](https://developer.globalpaymentsintegrated.com/#/landing/content/%2Fportal%2Fweb%2Fapi%2Fgenius-merchantware%2Fcheck?top=Genius%20API&amp;l1=Genius%20MerchantWare&amp;l2=Check#US\_States) • [Canadian Provinces and Territories](https://developer.globalpaymentsintegrated.com/#/landing/content/%2Fportal%2Fweb%2Fapi%2Fgenius-merchantware%2Fcheck?top=Genius%20API&amp;l1=Genius%20MerchantWare&amp;l2=Check#Canadian\_Provinces\_and\_Territories) • [ID Types](https://developer.globalpaymentsintegrated.com/#/landing/content/%2Fportal%2Fweb%2Fapi%2Fgenius-merchantware%2Fcheck?top=Genius%20API&amp;l1=Genius%20MerchantWare&amp;l2=Check#ID\_Types)
CourtesyCardNumber	String	0-50	A number the merchant assigns to the customer if they do not have a driver's license.

BoardingRequest

Name	Type	Size	Description
MerchantVaultTokenReference	String	1-100	A parameter that a merchant can use to add a tag to a customer's account. The merchant can add the same tag to many accounts so that they can group transactions.

CheckVaultBoardingResponse46

Name	Type	Description
VaultToken	String	A token for a specific checking account that a merchant boarded to the vault.
ErrorCode	String	A code representing a specific error. The code can be one of the following:• 1500 - Payment information not found • 99999 - Payment information not available.Note: Not all errors have an error code.
ErrorMessage	String	A message describing the error.

CheckVaultTokenResponse46

Name	Type	Description
CheckData	VaultCheckDataResponse	An object that contains information about the check.
ErrorCode	String	A code representing a specific error. The code can be one of the following:• 1500 - Payment information not found. • 99999 - Payment information not available.Note: Not all errors have an error code.
ErrorMessage	String	A message describing the error.
TokenData	TokenData	An object containing data about the token.

VaultCheckData

Name	Type	Size	Description
VerificationMethod	Enum VerificationMethod	0-21	The method you use to verify the customer's identity.
Check	VaultCheckInformation	-	The Check object contains fields that describe the check.
PersonalData	PersonalDataInformation	-	The checkholder's personal information.
HomeAddress	HomeAddressInformation	-	The checkholder's home address.
DriverLicense	DriverLicenseInformation	-	The checkholder's driver license information.

VaultCheckInformation

Name	Type	Size	Description
AccountType	String	1	The type of account the customer is using for the transaction. Verify against the Account Type codes.
CheckType	String	2	The type of check or checking account. Verify against the Check Type codes.
NameOnCheck	String	0-160	The customer's name that appears on the check. Note: You must send the customer's name in the format "FirstName SecondName" for check types that are "PE".
TransitNumber	String	0 - 9	The nine digit transit routing number. Note: Merchantware masks all digits except the last four in responses.
AccountNumber	String	0-18	The number of the customer's bank account. Note: Merchantware masks all digits except the last four in responses.

VaultCheckDataResponse

Name	Type	Size	Description
VerificationMethod	Enum VerificationMethod	0-21	The method you use to verify the customer's identity.
Check	VaultCheckInformationResponse	-	The Check object contains fields that describe the check.
PersonalData	PersonalDataInformationResponse	-	The checkholder's personal information.
HomeAddress	HomeAddressInformationResponse	-	The checkholder's home address.
DriverLicense	DriverLicenseInformationResponse	-	The checkholder's driver license information.

VaultCheckInformationResponse

Name	Type	Size	Description
AccountType	String	1	The type of account the customer is using for the transaction. Verify against the Account Type codes.
CheckType	String	2	The type of check or checking account. Verify against the Check Type codes.
NameOnCheck	String	0-160	The customer's name that appears on the check. Note: You must send the customer's name in the format "FirstName SecondName" for check types that are "PE".
TransitNumber	String	0 - 9	The nine digit transit routing number. Note: Merchantware masks all digits except the last four in responses.
AccountNumber	String	0-18	The number of the customer's bank account. Note: Merchantware masks all digits except the last four in responses.

VaultTokenRequest

Name	Type	Size	Description
VaultToken	String	1-40	A token for a specific checking account that a merchant boarded to the vault.

TokenData

Name	Type	Description
MerchantVaultTokenReference	String	A parameter that a merchant can use to add a tag to an account. The merchant can add the same tag to many accounts so that they can group transactions.
Status	String	Indicates the status of the VaultToken, which can be either "Boarded" or "Unboarded". The VaultToken is "Boarded" if the following are true:• The vault token exists in the Merchantware vault. • The vault token is active. • The vault token belongs to either the merchant sending the request or another merchant in the same merchant group. • You are sending a vault token from the Check vault.The VaultToken is "Unboarded" if the following are true:• The vault token exists in the Merchantware vault. • You deactivated the merchant's account using the UnboardAccount method. • The vault token belongs to either the merchant sending the request or another merchant in the same merchant group. • You are sending a vault token from the Check vault.

Source

Name	Description
Reader	If the source is reader, you need to include the following parameters in your request:• MICR • Transit Number • Account Number • Check Number
Keyed	If the source is keyed, you need to include the following parameters in your request:• Transit Number • Account Number • Check NumberNote: Do not provide CheckNumber if the check is recurring.
PreviousTransaction	If the source is a previous transaction, you need to include the following parameters in your request:• Token
Vault	If the source is vault token, you need to include the following parameters in your request:• VaultToken • Amount

VerificationMethod

Name	Description
DriverLicense	Specifying this requires the following information to be provided:• Driver’s License Details
Identity	Specifying this requires the following information to be provided:• Personal Data • Home Address
IdentityDriverLicense	Specifying this requires the following information to be provided:• Personal Data • Home Address • Driver’s License Details
None	If neither DriverLicense nor Identity are required.

Data Structures | Global Payments