Endpoints

URL	XML Endpoint
/EPNAPI/ACH.aspx	CGI
/EPNAPI/ACHXML.aspx	XML

Pages of Note

https://nuvei.atlassian.net/wiki/spaces/CKC/pages/5657886815

Endpoint Details

Parameters

Parameter Name	Type	Character Limit	Basic Requirements	With LexisNexis	With AccountCheck	Notes
Method	String	20	Yes			“Prenote". 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.
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	Yes			Normally this is the merchant's 6-digit Company Number.
Password	String	16	Yes
ReferenceNumber	String	40	Depends			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".
SECCode	String	3	Depends			Standard Entry Class code, such as “ARC”,”BOC”,”RCK”,"CCD", "PPD", "TEL", or "WEB". This is always required on certain merchant accounts; otherwise it should be left blank.
Descriptor	String	10	Depends			A description of the transaction that will appear on the client's bank statement. If you don't have explicit permission to submit this, then it should be left blank.
OriginateDate	Date	10	Optional			Date on which to originate the transaction, either today (default) or future. Format: "M/D/YYYY".
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.
Name	String	60	Required	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		10-digit North American phone numbers only.
Email	String	50	Optional
Birthday	Date	10	Optional	Depends		Format: "M/D/YYYY".
SSN	String	11	Optional	Depends		Social 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.
CustRefId	String		Optional	Optional		User information field, can be used to store additional data as needed.
ConsumerId	String	36	Optional			Format: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx Use the ConsumerId to specify an already saved Consumer from the recurring system.
Notes	String	60	Optional			Explanation of a transaction, stored for convenience
CustomField1	String	128	Optional
CustomField2	String	128	Optional
CustomField3	String	128	Optional
CustomField4	String	128	Optional
CustomField5	String	128	Optional
CustomField6	String	128	Optional
CustomField7	String	128	Optional
CustomField8	String	128	Optional
CustomField9	String	128	Optional
CustomField10	String	128	Optional

Please note that the information provided in the notes is for informational purposes only. We maintain updates in the notes field as they progress through our system during processing. Please be aware that notes may change at any time and should not be relied upon for data parsing.

/EPNAPI/ACH.aspx

Request

/EpnApi/ACH.aspx?Method=Prenote&Version=1.4.2.34&Login={MerchanLogin}&Password={MerchantPassword}&Test=true&Savings=true&SECCode=PPD&RoutingNumber=888888884&AccountNumber=12565585

Response

Network=ACH
Method=PrenoteDebit
Version=1.4.2
Test=True
Success=True
Severity=0
Message=Prenote requested
TransactionID=1903707078
Status=Accepted
Note=PrevPay: nil +0 
Note=Score: 0

/EPNAPI/ACHXML.aspx