ACH

Methods related to ACH (Automated Clearing House) transactions

Apply Credit to ACH Transaction

POST /ICardProcess/ACH_ApplyCredit

Applies a credit to the specified ACH transaction. Credits can be applied after a transaction has been settled; open transactions should use the ACHTransaction_Void method.

Request body

SessKey string

A unique session key used for authentication in API calls. This key is generated upon successful authentication and must be included in all subsequent requests.

Example: B9F24903C3BA4770AE303032303541303032353437

---

ConsentID int

This is the the ID number that is returned after you save a card on file.

---

ProcessAmount decimal

The $ amount which you want to charge a card that is already on file as an annual consent.

Response body

FunctionOk boolean

Indicates if the function executed correctly.

---

RespMsg string

Friendly response message for the user.

---

ErrMsg string

Error message. Empty or null if no error.

---

ErrCode int

Error code. 0 indicates success.

---

TxApproved boolean

Indicates if the transaction was approved.

---

TxID int

A unique ID of the transaction.

Process Payment - ACH Consent Annual

POST /ICardProcess/ACHConsentAnnual_ProcPayment

Processes the specified $ amount against the associated ACH consent.

Request body

SessKey string

A unique session key used for authentication in API calls. This key is generated upon successful authentication and must be included in all subsequent requests.

Example: B9F24903C3BA4770AE303032303541303032353437

---

ConsentID int

This is the the ID number that is returned after you save a card on file.

---

ProcessAmount decimal

The $ amount which you want to charge a card that is already on file as an annual consent.

Response body

FunctionOk boolean

Indicates if the function executed correctly.

---

RespMsg string

Friendly response message for the user.

---

ErrMsg string

Error message. Empty or null if no error.

---

ErrCode int

Error code. 0 indicates success.

---

TxApproved boolean

Indicates if the transaction was approved.

---

TxID int

A unique ID of the transaction.

---

AuthID string

The authorization ID provided by the payment processor upon approval of the transaction.

---

uniqueTranID string

A unique identifier for the transaction from the processor that can be used for tracking and reconciliation purposes.

Process Payment - Alt Merchant - ACH Consent Annual

POST /ICardProcess/ACHConsentAnnual_ProcPayment_Alt

Processes the specified $ amount for an existing ACH consent, but the payment is transferred to a different merchant than the original one.

The alternate merchant must be previously assigned to the account holders' account.

When you create a 'card on file' or consent, you specify a merchant. When processing the consent, the system defaults to sending these funds to the original merchant.

If you plan to process with an alternate merchant, ask your support rep to adjust the settings on your account to ProcessCreditWithAlternateMerchant = true.

Request body

SessKey string

A unique session key used for authentication in API calls. This key is generated upon successful authentication and must be included in all subsequent requests.

Example: B9F24903C3BA4770AE303032303541303032353437

---

ConsentID int

This is the the ID number that is returned after you save a card on file.

---

ProcessAmount decimal

The $ amount which you want to charge a card that is already on file as an annual consent.

---

AlternateMerchID int

The ID of the merchant to send the funds to.

Response body

FunctionOk boolean

Indicates if the function executed correctly.

---

RespMsg string

Friendly response message for the user.

---

ErrMsg string

Error message. Empty or null if no error.

---

ErrCode int

Error code. 0 indicates success.

---

TxApproved boolean

Indicates if the transaction was approved.

---

TxID int

A unique ID of the transaction.

---

AuthID string

The authorization ID provided by the payment processor upon approval of the transaction.

---

uniqueTranID string

A unique identifier for the transaction from the processor that can be used for tracking and reconciliation purposes.

ACH Transaction Query

POST /ICardProcess/ACHTransaction_Query

Returns the details for an ACH transaction. This query can return more than one transaction if searching for a range. Number has a query language that aids in search.

Request body

SessKey string

A unique session key used for authentication in API calls. This key is generated upon successful authentication and must be included in all subsequent requests.

Example: B9F24903C3BA4770AE303032303541303032353437

---

Query string

A query string for obtaining specific consent records using Number's query language. Build logical terms and join them with '&&' for logical AND or '||' for logical OR. Use single quotes for text and date values. Refer to the variable chart for query composition:

• A: MERCHANT ID - The merchant record you are interested in, e.g. (A=1).

• B: TRANSACTION STATUS - The status of the transaction, e.g. (B=1).

  • -1: ALL

  • 1: OPEN

  • 2: SETTLED

  • 3: FAILED

  • 4: LOCKED

  • 5: VOID

• C: DATE CREATED - The date the transaction was created, e.g. (C>='7/5/2024 12:00:00 AM').

• D: LAST NAME - Last name of the account holder, e.g. (D LIKE '%MITH') for all names that end with 'MITH'.

• E: TRANSACTION LOCK - Lock status of the transaction, e.g. (E<>'0') for locked transactions.

• F: BATCH LOG ID - Reference to a batch settlement record, e.g. (F=817).

• H: TRANSACTION ID - The unique identifier for the transaction, e.g. (H=58258).

• J: FIRST NAME - First name of the account holder, e.g. (J LIKE 'ROB%') for all names that start with 'ROB'.

• K: TRANSACTION TYPE - The type of transaction, e.g. (K=-1).

  • -1: ALL

  • 1: CCAUTHONLY

  • 2: CCSALE

  • 3: CCFORCE

  • 4: CCVOICE

  • 5: CCADJUST

  • 6: CCCREDIT

• L: AMOUNT - The $ amount of the transaction, e.g. (L>100.00).

• M: CLIENT REFERENCE ID - User-defined value on the transaction.

• N: RPGUID - User-defined value on the transaction.

• P: CONSENT ID - The Consent ID of card on file the transactions were charged against, e.g. (P=15875).

• Q: CREDIT CARD LAST 4 - The last 4 digits of a credit card, e.g. (Q='4123').

• R: APPROVAL CODE - The approval code for the transaction, e.g. (R='TAS626').

• S: CUSTOMER LAST NAME - The last name of the customer, e.g. (S='SMITH').

• T: CUSTOMER FIRST NAME - The first name of the customer, e.g. (T='FOSTER').

• U: ORIGIN - The origin of the transaction, e.g. (U='API').

  • "API": REST / SOAP API

  • "WID": Widget

  • "VT": Virtual Terminal

  • "MOBL": Mobile SDK

  • "SDK": Verifone

  • "AUTO": Automatically scheduled from a payment plan

• W: BATCH NUMBER - The batch number for the batch settlement, e.g. (W=762).

Example: "(B=3)&&(E=1)&&(C>'2024-09-01')"

Response body

FunctionOk boolean

Indicates if the function executed correctly.

---

RespMsg string

Friendly response message for the user.

---

ErrMsg string

Error message. Empty or null if no error.

---

ErrCode int

Error code. 0 indicates success.

---

NumRecords int

The number of records returned in the response.

---

Transactions List<api_ACHDetail> (array<object>)

The ACH transaction details returned by the query.

Fields: ID, UniqueID, TXstamp, TXN_DATETIME, AuthID, ValMsg, CreatedBy, CreatedOn, ChangedBy, ChangedOn, AcctType, Origin, RefTxID, REF_ID, RPGUID, AcctHolderID, EndCustID, TxSTATUS, TxType, Credits, Amt, MerchID, UserID, ResolvedOn, SettledOn, BatchNO, BatchStatus, BatchLogID, AcctLast4, ReturnReason, CustName, FirstName, LastName, ConsentID.

Sample response

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
                  xmlns:ns="http://example.com/soapapi">
   <soapenv:Header/>
   <soapenv:Body>
      <ns:api_TransactionQryResponse>
         <ns:FunctionOk>true</ns:FunctionOk>
         <ns:RespMsg>Successfully Returned Transaction Records : 1</ns:RespMsg>
         <ns:ErrMsg></ns:ErrMsg>
         <ns:ErrCode>0</ns:ErrCode>
         <ns:NumRecords>1</ns:NumRecords>
         <ns:Transactions>
            <ns:api_ACHDetail>
               <ns:ID>1405</ns:ID>
               <ns:UniqueID>167901CDE082BC57</ns:UniqueID>
               <ns:TXstamp>20240703</ns:TXstamp>
               <ns:TXN_DATETIME>2024-07-03T00:00:00-04:00</ns:TXN_DATETIME>
               <ns:AuthID>69019079</ns:AuthID>
               <ns:ValMsg>Success</ns:ValMsg>
               <ns:CreatedBy>Token 37564</ns:CreatedBy>
               <ns:CreatedOn>2024-06-30T09:37:52-04:00</ns:CreatedOn>
               <ns:ChangedBy xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
               <ns:ChangedOn>0001-01-01T00:00:00-05:00</ns:ChangedOn>
               <ns:AcctType>PersonalChecking</ns:AcctType>
               <ns:Origin>API       </ns:Origin>
               <ns:RefTxID>0</ns:RefTxID>
               <ns:REF_ID>12456AA</ns:REF_ID>
               <ns:RPGUID>3d3424a6-c5f3-4c28</ns:RPGUID>
               <ns:AcctHolderID>1127</ns:AcctHolderID>
               <ns:EndCustID>35348</ns:EndCustID>
               <ns:TxSTATUS>SETTLED</ns:TxSTATUS>
               <ns:TxType>ACHDEBIT</ns:TxType>
               <ns:Credits>0.0000</ns:Credits>
               <ns:Amt>30.5000</ns:Amt>
               <ns:MerchID>1</ns:MerchID>
               <ns:UserID>0</ns:UserID>
               <ns:ResolvedOn>2024-07-05T10:06:41-04:00</ns:ResolvedOn>
               <ns:SettledOn>2024-07-05T00:00:00-04:00</ns:SettledOn>
               <ns:BatchNO>112</ns:BatchNO>
               <ns:BatchStatus>N</ns:BatchStatus>
               <ns:BatchLogID>0</ns:BatchLogID>
               <ns:AcctLast4>0277</ns:AcctLast4>
               <ns:ReturnReason></ns:ReturnReason>
               <ns:CustName>APIACH Sally</ns:CustName>
               <ns:FirstName>Sally</ns:FirstName>
               <ns:LastName>APIACH</ns:LastName>
               <ns:ConsentID>0</ns:ConsentID>
            </ns:api_ACHDetail>
         </ns:Transactions>
      </ns:api_TransactionQryResponse>
   </soapenv:Body>
</soapenv:Envelope>

ACH Transaction Void

POST /ICardProcess/ACHTransaction_Void

Voids an ACH transaction. The transaction can be voided before it is settled. Once a transaction has been settled, the ACH_ApplyCredit method should be used.

Request body

SessKey string

A unique session key used for authentication in API calls. This key is generated upon successful authentication and must be included in all subsequent requests.

Example: B9F24903C3BA4770AE303032303541303032353437

---

TxID int

A unique ID of the transaction.

Response body

FunctionOk boolean

Indicates if the function executed correctly.

---

RespMsg string

Friendly response message for the user.

---

ErrMsg string

Error message. Empty or null if no error.

---

ErrCode int

Error code. 0 indicates success.

---

TxApproved boolean

Indicates if the transaction was approved.

---

TxID int

A unique ID of the transaction.

---

AuthID string

Unique identifier for the authorization of the transaction.