ACHeck21 Gateway - Version 2.8
This system provides a number of SOAP Web Methods used to provide ACH and Check 21 service functionality to remote applications.
The following operations are supported. For a formal definition, please review the Service Description.
-
ApproveBatch
Approves a specific batch, moving it from a "Pending" state to an "Approved" state. Once a batch is approved, editing is no longer possible and processing has begun. -
Authenticate
Authenticates the given credentials without returning a session key. -
CreateBillPay
Create a new transaction as an ACH bill pay. -
CreateCheck
Create a new transaction. -
CreateCheckEx
Create a new transaction. -
CreateCheckWithIR
Create a new transaction using ACH to Check 21 intelligent routing. -
CreateNOC
Creates a Notification of Change (NOC) entry for the given check -
CreateRCC
Creates an RCC transaction. -
CreateReturn
Creates a return for an existing item. -
CreateUser
Creates a new user. An email with a temporary password will be sent to the user. -
CreateValidatedCheck
Creates a new transaction after first validating using the ValidateCheck method. -
CreateValidatedCheckWithIR
Creates a new transaction with Intelligent Routing after first validating using the ValidateCheck method. -
CreateValidatedRCC
Creates an RCC transaction. -
DeleteBatch
Deletes a specific batch moving it from a "Pending" state to a "Deleted" state. Once a batch is deleted, editing is no longer possible. -
DeleteCheck
Deletes an existing document from the system. This is only possible until the item is submitted into the ACH system -
DeleteUser
Deletes a user. -
ExtendSessionToken
Extends the expiration of the session token. -
FindBatches
Retrieves a listing of all batches that match the parameter criteria. -
FindChecks
Returns a listing of all documents that match the parameter criteria. -
FindChecksDetails
Returns details of all documents that match the parameter criteria. -
FindClientUsers
Retrieves the list of users that have access to a specified client. -
FindNoticesOfChange
Retrieves a listing of all Notices Of Change that match the parameter criteria. -
FindPendingChecks
Returns a list of all pending documents that match the parameter criteria. -
FindPendingChecksDetails
Returns details of all pending documents that match the parameter criteria. -
FindReturns
Retrieves a listing of all returned documents that match the parameter criteria. -
FindReturnsDetails
Retrieves details of all returned documents that match the parameter criteria. -
FindUserClients
Returns the list of clients that the specified user can access. -
GetBatch
Retrieves the details of a particular batch. To retrieve individual transactions, use FindChecks. -
GetCheck
Retrieves information, including return status, about a single document from the system. -
GetChecks
Retrieves information, including return status, about one or more uploaded documents. -
GetClient
Returns basic control information about an individual client from the client ID. -
GetRoles
Retrieves the list of system-known roles. -
GetUser
Returns information about a specific user. -
Login
Authenticates the given credentials, returning a session key. -
Logout
Invalidates the given session token. -
RepresentCheck
Re-presents a document. The document must have an un-represented return outstanding. -
SendBatch
Accepts a Base64-encoded string of a batch file. This batch must follow the XML, CSV or XFR specification. For more information, please contact customer support to obtain documentation on the proper batch format. -
SendRCKBatch
Accepts a Base64-encoded string of a batch file containing RCK items. This batch must follow the XML, CSV or XFR specification. For more information, please contact customer support to obtain documentation on the proper batch format. -
UpdateUser
Updates information about a user. -
ValidateCheck
Validates and optionally authorizes a check. The MICR and Components (RTN/DDA/CN) are mutually exclusive. -
VerifyTransitNumber
Verifies that the given TransitNumber is a known transit number using FedACH.