Developer API Reference

Electronic Checking Data Elements

The following Electronic Checking data elements are required in all Electronic Checking (ACH) transactions, unless noted otherwise. The 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.

CheckData

Basic information about the check being processed. This element is Required.

Required Parameter Description Data Type
X AccountNumber Account number on the check. String
X CheckCountryCodeBank Account country of origin for receiver. Enum
Optional CheckNumber The check number as printed on the check. String
X OwnerType Indicates the type of entity which owns the account. Enum
X RoutingNumber 9-digit bank routing number of the receiver deposit account. String
X UseType Indicates the type of account. Enum

ElectronicCheckingCaptureResponse

Response to capturing an Electronic Checking transaction. This element is Expected.

Note: ElectronicCheckingCaptureResponse inherits the data elements in Response.

ElectronicCheckingCaptureResponse is returned by the following Transaction Processing operation signatures:

  • Capture
  • CaptureAll
  • CaptureAllAsync
Required Parameter Description Data Type
X SummaryData Summary information (item count and total amount) for the captured transaction. Object

ElectronicCheckingCustomerData

Contains information about the Electronic Checking customer.

Required Parameter Description Data Type
Optional AdditionalBillingData Additional billing information which may be required by the service provider to process the Electronic Checking transaction. – Maps to PersonalInfo. Object

ElectronicCheckingTenderData

Contains information about the Electronic Checking transaction tender data. This element is Required.

Required Parameter Description Data Type
X CheckData Basic information about the check being processed. Object

ElectronicCheckingTransaction

Contains information about the Electronic Checking transaction. This element is Required.

Required Parameter Description Data Type
Optional ElectronicCheckingCustomerData Details about the customer. Object
X ElectronicCheckingTenderData Details about the tender. Object
X ElectronicCheckingTransactionData Details about the transaction data. Object

ElectronicCheckingTransactionData

Contains information about the dat in an Electronic Checking transaction. This element is Required.

Required Parameter Description Data Type
X EffectiveDate Specifies the effective date of the transaction. DateTime
Conditional* IsRecurring Indicates whether the transaction is recurring. *Required if SECCode = ‘WEB’. Boolean
Optional PayeeEmail Specifies the payee’s email address. String
X PayeeId Specifies the reference number used by the payer to identify the payee. String
X SECCode The three letter code that indicates what NACHA regulations required for the transaction. Enum
X ServiceType Indicates the Electronic Checking service type: ACH, RDC or ECK. Enum
X TransactionType Indicates the transaction type. Enum

ElectronicCheckingTransactionResponse

Response returned for an Electronic Checking transaction. This element is Expected.

Note: ElectronicCheckingTransactionResponse inherits the data elements in Response.
Required Parameter Description Data Type
Optional ACHCapable Indicates if the customer account accepts ACH transactions. Returned only on QueryAccount transactions. Boolean
Optional Amount Indicates the amount of the transaction. Decimal
Optional ApprovalCode A code provided when a transaction is approved. String
Optional ModifiedAccountNumber Indicates the corrected account number that should be used for electronic check processing. String
Optional ModifiedRoutingNumber Indicates the corrected 9-digit bank routing number that should be used for electronic check processing. String
Conditional* PaymentAccountDataToken
    Token specified by a tokenization (offsite payment account data storage) service provider, used to retrieve securely stored payment account data. *Required if any one of the following must be provided:

  • PaymentAccountDataToken
  • SecurePaymentAccountData
  • Tender-specific payment account data
String

ReturnInformation

Contains information regarding the reason the bank rejected the transaction. This element is Optional.

Required Parameter Description Data Type
Optional ReturnCode Code that indicates why the transaction was returned. String
Optional ReturnDate The date the transaction was returned by the bank. DateTime
Optional ReturnReason Reason that indicates why the transaction was returned. String