API Docs
The following Electronic Checking data elements are required in all Electronic Checking (ACH) transactions, unless noted otherwise. These data elements are included with each Electronic Checking transaction in addition to Base Transaction data elements.
Note: While the Base Transaction data elements are required, your application cannot send a transaction containing only Base Transaction data elements. Electronic Checking-specific transaction data is required to successfully process any Electronic Checking transaction.
Allows the merchant to specify alternative information to show up on the customers credit card statement. Only supported by some proviers. Optional.
Parameter | Description | Data Type |
Description | Specifies a description of the product or service. Optional. | String |
Name | Specifies an alternative merchant name or DBA. Optional. | String |
Basic information about the check being processed. Required.
Parameter | Description | Data Type |
AccountNumber | Account number on the check. Required. | String |
CheckCountryCode | Bank account country of origin for receiver deposit. Required. | Enum |
CheckNumber | The check number as printed on the check. Optional. | String |
OwnerType | Indicates the type of entity which owns the account. Required. | Enum |
RoutingNumber | 9-digit bank routing number of the receiver deposit account. Required. | String |
RawMICRLine | TOAD formatted Raw MICR data. Optional. |
String |
UseType | Indicates the type of account. Required. |
Enum |
Image data for the check being submitted. Conditional.
Parameter | Description | Data Type |
CompressionType | Indicates the type of compression used | Enum |
DocType | Indicates the document type. Required. | Enum |
FormatType | Indicates the format of the image. Required. | Enum |
ImgData | Binary image data encoded as Base64 String. Required. | btye[] |
ImgSize | The length of the data included in the ImgData element. Required. | Int |
UserField | Refrence field to be passed along with image view in x9.37 file. Optional. | String |
Response to capturing an Electronic Checking transaction. Expected.
Note: ElectronicCheckingCaptureResponse inherits the data elements in Response.
ElectronicCheckingCaptureResponse is returned by the following Transaction Processing operation signatures:
Parameter | Description | Data Type |
SummaryData | Summary information (item count and total amount) for the captured transactions. Required. | Object |
Contains information about the Electronic Checking customer. Note that this class inherits all fields of TransactionCustomerData.
Parameter | Description | Data Type |
AdditionalBillingData | Additional billing information which may be required by the service provider to process the Electronic Checking transaction. Optional. | Object |
Contains information about the Electronic Checking transaction tender data. Required.
ParameterDescriptionData TypeParameterDescriptionData Type
Parameter | Description | Data Type |
CheckData | Basic information about the check being processed. Required. | Object |
BackCheckImage | Image of the back of the source document. | Object |
FrontCheckImage | Image of the front of the source document | Object |
SocketLocation | Store location information. Conditional. | Object |
Contains information about the Electronic Checking transaction. Required.
Parameter | Description | Data Type |
ElectronicCheckingCustomerData | Details about the customer. Optional. | Object |
ElectronicCheckingTenderData | Details about the tender. Required. | Object |
ElectronicCheckingTransactionData | Details about the transaction data. Required. | Object |
Contains information about the Electronic Checking transaction data. Required.
AlternativeMerchantData
Parameter | Description | Data Type |
AlternativeMerchantData | Alternative merchant data to appear on the account holders statements. Only supported by some providers. Optional. | Object |
EffectiveDate | Specifies the effective date of the transaction. Required. | DateTime |
IsRecurring | Indicates whether the transaction is recurring. Conditional, required if SECCode = ‘WEB’. | Boolean |
PayeeEmail | Specifies the payee’s email address. Optional. | String |
PayeeId | Specifies the reference number used by the payer to identify the payee. Required. | String |
SECCode | The three letter code that indicates what NACHA regulations the transaction must adhere to. Required. | Enum |
ServiceType | Indicates the Electronic Checking service type: ACH, RDC or ECK. Required. | Enum |
TransactionType | Indicates the transaction type. Required. | Enum |
TxnCodeType | Specifies the specific type of transaction. Conditional. | Enum |
Contains information for undoing (voiding) Electronic Checking transactions. Required.
The following Transaction Processing operation signatures accept ElectronicCheckingUndo as a parameter:
Parameter | Description | Data Type |
TransactionID | The TransactionID from the original transaction that should be voided. | String |
UndoType | The type of undo to performe. Conditional. | Enum |
Response returned for an Electronic Checking transaction. Expected.
Note: ElectronicCheckingTransactionResponse inherits the data elements in Response.
Parameter | Description | Data Type |
ACHCapable | Indicates if the customer’s account will accept ACH transactions. Returned only on QueryAccount transactions. Optional. | Boolean |
Amount | Indicates the amount of the transaction. Optional. | Decimal |
ApprovalCode | A code provided when a transaction is approved. Optional. | String |
ModifiedAccountNumber | Indicates the corrected account number that should be used for electronic check processing. Optional. | String |
ModifiedRoutingNumber | Indicates the corrected 9-digit bank routing number that should be used for electronic check processing. Optional. | String |
PaymentAccountDataToken | Token specified by a tokenization (offsite payment account data storage) service provider, used to retrieve securely stored payment account data. Conditional, required if any one of the following must be provided:
|
String |
ReturnInformation | Contains information indicating why the transaction was returned. Optional. | Object |
SubmitDate | The date the transaction was submitted to the bank. Optional. | DateTime |
RspTxnCode | TxnCode returnd from Service Provider. Optional. | String |
Contains a customer’s sensitive personal information. Optional.
Parameter | Description | Data Type |
Company | Company name. Optional | String |
DateOfBirth | The customer’s date of birth. Optional. | DateTime |
DriversLicense | Parameterized driver’s license information for the customer. Optional. | Object |
EmployeeIdNumber | Employee identification number, which can be used as an alternate form of identification. Optional. | String |
Gender | The customer’s gender. Optional. | String |
GovernmentIdNumber | Government issued identification number, which can be used as an alternate form of identification. Optional. | String |
MilitaryIdNumber | Military issued identification number, which can be used as an alternate form of identification. Optional. | String |
SocialSecurityNumber | The customer’s social security number. Optional. | String |
TaxId | The customer’s federal tax identifier. Optional. | String |
Contains information about the reason the bank rejected the transaction.
Parameter | Description | Data Type |
ReturnCode | Code that indicates why the transaction was returned. Optional. | String |
ReturnDate | The date the transaction was returned by the bank. Optional. | DateTime |
ReturnReason | Reason that indicates why the transaction was returned. Optional. | String |
Store location information.
Parameter | Description | Data Type |
SocketCity | Location city. Required. | String |
SocketState | Location State. Required. | string |
Updated: June 2, 2017
SUBMIT A DEVELOPER SUPPORT REQUEST
Agent or a merchant? Contact NAB support at 866.485.8999 EXT 2341