Status

Gets the ACH Transaction status information.

Endpoints

URL

XML Endpoint

/EPNAPI/ACH.aspx

CGI

/EPNAPI/ACHXML.aspx

XML

Pages of Note

Transactions Status Flow

Transaction Errors and Severity Levels

Transaction Status Codes Guide

Endpoint Details

Parameters

Parameter Name

Type

Character Limit

Required

Notes

Method

String

20

Yes

"Status".  This parameter is not submitted to WebService interfaces because it is implied by the WebService method being called.

Version

String

15

Yes

Version of the API with which you integrated.  Should be at least "1.4.2".

ResponseXML

Boolean

5

"True" for an XML response.  "False" (default) for a simple text response.  The "ResponseXML" parameter is not submitted to XML interfaces because they always return an XML response.

Login

String

16

Yes

Normally this is the merchant's 6-digit Company Number.

Password

String

16

Yes

TransactionID

Int64

20

Yes

Number assigned by Check Commerce to the transaction which is to be queried.

ReferenceNumber

String

40

Depends

Identifier assigned by Merchant to the transaction which is to be queried.

Notes:

One of the two parameters TransactionID or ReferenceNumber must be provided to identify the transaction to be queried.

The status of the specified transaction will be returned in the Message field as well as the Status field of the response.

/EPNAPI/ACH.aspx

Request

/EpnApi/ACH.aspx?Method=Status&Version=1.4.2.34&Login={MerchanLogin}&Password={MerchantPassword}&TransactionID=1903707077

Response

Network=ACH
Method=Status
Version=1.4
Test=True
Success=True
Severity=0
Message=Accepted
TransactionID=1903707077
Status=Accepted
Note=Recurring payment scheduled for 2024-04-08 00:00:00 Note=PrevPay: nil +0 Note=PlaidBalance PBC: Plaid Balance check no consumer id +0 Note=Score: 100/100

/EPNAPI/ACHXML.aspx

Request

<ACH>
    <Method>Status</Method>
    <Login>{Merchant Login}</Login>
    <Password>{Merchant Password}</Password>
    <Version>1.4.2.34</Version>
    <TransactionID>1903707077</TransactionID>
</ACH>

Response

<?xml version="1.0"?>
<Response Network="ACH" Method="Status" Version="1.4.2" Test="True" Success="True" Severity="0" TransactionID="1903707077" Status="Accepted"> 
  <Message>Accepted</Message> 
  <Notes> 
    <Note>Recurring payment scheduled for 2024-04-08 00:00:00</Note> 
    <Note>PrevPay: nil +0</Note> 
    <Note>PlaidBalance PBC: Plaid Balance check no consumer id +0</Note> 
    <Note>Score: 100/100</Note> 
  </Notes> 
</Response>

Search