Overview

1. Basic Request Template – The following table defines the basic data fields that will be required when submitting any request through the ACHQ Payment API:

Field Name	Usage	Field Value Format Constraints
ProviderID	Required	Provided by your Account Manager
Provider_GateID	Required	Provided by your Account Manager
Provider_GateKey	Required	Provided by your Account Manager
MerchantID	Required	Provided to the merchant by ACHQ
Merchant_GateID	Required	Provided to the merchant by ACHQ
Merchant_GateKey	Required	Provided to the merchant by ACHQ
CommandVersion	Required	Set to 2.0 to enforce this API documentation revision
TestMode	Optional	Set this value to On to generate an API response without creating a record

2. Submitting a an API request – To submit an API request to ACHQ, use either HTTP POST or GET to transmit the necessary fields to the following secure URL:

https://www.speedchex.com/datalinks/transact.aspx

If using HTTP GET, please make sure that all data values have been encoded to be URL-safe.

3. Response Template – In response to any command, the ACHQ API will return a JSON response indicating whether the command succeeded or failed and any additional information necessary to interpret the response. The following table defines the field values that will be returned in every response and their meaning:

Field Name	Field Contents	Max Length	Additional Information
CommandStatus	Returns one of the following values: • Approved • Declined • Error	30	Indicates the success or failure of the command issued.
ResponseCode	A 3 digit code indicating command success or reason for command failure.	3	Refer to Response Code Definitions for a list of possible values
Description	Description of the ResponseCode value	255	Refer to Response Code Definitions for a list of possible values
ErrorInformation	Additional information to help determine the source of an error.	50	Refer to Response Code Definitions for a list of possible values
ExpressVerify.Status	Returns one of the following values if Express Verify is activated: ‘POS’, ‘NEG’, ‘UNK’ or ‘ERR’.	3	Refer to Verification Code Definitions for a list of possible values
ExpressVerify.Code	A code indicating the reason for the ExpressVerify.Status value	5	Refer to Verification Code Definitions for a list of possible values
ExpressVerify.Description	A brief explanation for the ExpressVerify.Status value	255	Refer to Verification Code Definitions for a list of possible values
ResponseData	Please see the documentation for the specific command to be issued for an explanation of the possible value(s) for this field.		This is a generic object that can take the form of any scalar or complex object called for by the command that is issued.
ACHQToken	A unique token that can be used to represent the supplied bank routing and account information on any future payments.	50	A token will only be generated if directed requested on the Create_ACHQToken parameter.
Provider_TransactionID	The Provider_TransactionID value defined in the command.	50	This value can be used as a transaction reference when processing responses must be deferred (like for batch uploads)
Transact_ReferenceID	A unique ID assigned to each command submitted to the ACHQ Gateway.	30	This value can be used for as a unique transaction identifier or as a reference for support on any command.

Note: The ECheck.VerifyPlus command contains additional response fields detailed in that command ‘s definition