Addenda

Adds ACH Addenda information to a transaction to be built into a file.  This is for CCD+ and PPD+. It is almost never necessary to use an Addenda record.  Your account must also have the options for Addendas enabled before you can use this feature.

Endpoints

URL

XML Endpoint

/EPNAPI/ACH.aspx

CGI

/EPNAPI/ACHXML.aspx

XML

Pages of Note

Transaction Errors and Severity Levels

Endpoint Details

Parameters

Parameter Name

Type

Character Limit

Required

Notes

Method

String

20

Yes

"Addenda".  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. 

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.

SequenceNumber

String

16

Depends

You need to specify a SequenceNumber if you want to edit an Addenda that isn’t the first. It is unusual to have more than one addenda be necessary.

Addenda

String

80

The addenda information can be attached to a transaction. This is commonly used to specify extra account information that the IRS may need to match your payment to their system.

/EPNAPI/ACH.aspx

Request

/EpnApi/ACH.aspx?Method=Addenda&Version=1.4.2.35&Login={MerchanLogin}&Password={MerchantPAssword}&TransactionID=123456780&SequenceNumber=1&Addenda=TestAddenda

Response

Method=Addenda
Version=1.4
Test=True
Success=True
Severity=0
Message=Accepted

/EPNAPI/ACHXML.aspx

Request

<ACH>
    <Method>Addenda</Method>
    <Login>{Merchant Login}</Login>
    <Password>{Merchant Password}</Password>
    <Version>1.4.2.35</Version>
    <TransactionID>123456780</TransactionID>
    <SequenceNumber>1</SequenceNumber>
    <Addenda>TestAddenda</Addenda>
</ACH>

Response

<?xml version="1.0"?>
<Response Method="Addenda" Version="1.4.2.35" Test="False" Success="True" Severity="0" TransactionID="123456780" AddendaSequenceNo="1" ApprovalCode="">
    <Message>Accepted</Message>
</Response>

Search