Authorize

Create an Authorization, note that the Authorize method creates records that appear on the Authorization Log webpage, not the Transaction Log webpage.  If you have LexisNexis verification enabled:  LexisNexis only verifies name, address, phone number, birthday, and SSN if these options are enabled on the merchant account.

Endpoints

URL

XML Endpoint

/EPNAPI/ACH.aspx

CGI

/EPNAPI/ACHXML.aspx

XML

Pages of Noe

Transaction Errors and Severity Levels

Endpoint Details

Parameters for ACH Method: Authorize

Parameter Name

Type

Character Limit

Required

With LexisNexis

With AccountCheck

Note

Method

String

20

Required

 

 

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

Version

String

15

Required

 

 

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

ResponseXML

Boolean

5

Optional

 

"

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.

Test

Boolean

5

Optional

 

 

"True" if this is just a test that should not be finalized.  "False" (default) if this is a live/production request.

Login

String

16

Required

 

 

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

Password

String

16

Required

 

 

 

ReferenceNumber

String

40

Required

 

 

Merchant's identifier for the transaction, to be stored for convenience.  This can be a number from the merchant's own database, or it can be ignored by passing "0".

Amount

Decimal

9

Required

 

Required

U.S. Dollars.

RoutingNumber

String

9

Required

 

Required

Always 9 digits.

AccountNumber

String

17

Required

 

Required

Numerals only.

Savings

Boolean

5

Optional

 

Optional

"True" if this is a savings account.  "False" (default) if this is a checking account.

CheckNumber

String

8

Optional

 

Optional

 

Name

String

60

Optional

Required

 

Consumer's full name, first name first, last name last, with no commas.

Address1

String

50

Optional

Required

 

Street and number.

Address2

String

50

Optional

Optional

 

Unit number, etc.

City

String

50

Optional

Required

 

 

State

String

2

Optional

Required

 

 

Zip

String

10

Optional

Required

 

Can be 5 or 9 digits.

Phone

String

16

Optional

Depends

 

110-digit North American phone numbers only.

Email

String

50

Optional

 

 

 

Birthday

Date

10

Optional

Depends

 

1Format: "M/D/YYYY".

SSN

String

11

Optional

Depends

 

1Social Security Number.  Format can be "123456789" or "123-45-6789" or "6789".  Can be 0 to omit.

DLN

String

40

Optional

Optional

 

Driver's License Number.

DLS

String

2

Optional

Optional

 

Driver's License State whence issued.

ConsumerId

string

36

Optional

Optional

 

Optional to authorize a previously saved consumer.

Notes

String

60

Optional

Optional

 

Explanation of an authorization, stored for convenience

/EPNAPI/ACH.aspx

Request

/EpnApi/ACH.aspx?Password={MerchantPAssword}&Method=Authorize&Version=1.4.2.35&Login={MerchanLogin}&ReferenceNumber=1904885730&Amount=1&RoutingNumber=123456780&AccountNumber=123456788

Response

Method=Authorize
Version=1.4.2.35
Test=True
Success=True
Severity=0
Message=Authorization successful.
TransactionID=1502940333
Status=Authentication
ApprovalCode=
Note=PrevPay: nil +0
Note=Score: 100/100
Score=nil
ConsumerId=c4974ec6-6600-4963-92fe-fd6ff33b0adc

/EPNAPI/ACHXML.aspx

Request

<?xml version="1.0"?>
<ACH>
  <Method>Authorize</Method>
  <Version>1.4.2</Version>
  <Login>{MerchantLogin}</Login>
  <Password>{MerchantPassword}</Password>
  <ReferenceNumber>561</ReferenceNumber>
  <Amount>1</Amount>
  <RoutingNumber>123456780</RoutingNumber>
  <AccountNumber>11111</AccountNumber>
  <OriginateDate/>
</ACH>

Response

<?xml version="1.0"?>
<Response Method="Authorize" Version="1.4.2" Test="True" Success="True" Severity="0" TransactionID="1502940334" Status="Accepted">
    <Message>Authorization successful.</Message>
    <Notes>
        <Note>PrevPay: nil +0</Note>
        <Note>Score: 100/100</Note>
    </Notes>
</Response>