Paper Check API
Description
The Paper Checks feature allows you to issue physical checks through an API endpoint. This functionality enables the sending of paper checks for credit purposes to both individuals and businesses.
Note: A merchant must be setup to use Paper Checks. When this occurs a Bank Token will be issued for use in the API Requests
Endpoints
URL | Endpoint Type |
---|---|
/EPNAPI/Transaction.aspx | SOAP |
Parameters
Type | Character Limit | Basic Requirements | Notes | |
ReferenceNumber | String | 100 | Merchant Transaction Id | |
OriginateDate | DateTime | Check Payment Date: The date that should be printed on the check. When it is blank or omitted, the current date will be printed. | ||
Amount | Decimal | > 0 | Amount to be Paid | |
CheckNumber | String | 9 Digits | Number | The Number of the Check |
Address1 | String | 256 | Required | The Customer's Address |
City | String | 256 | Required | The Customer’s City |
State | String | 2 | Required | The Customer’s State |
Zipcode | String | 20 | Required | The Customer's Zip Code |
Phone | String | 20 | Required if Shipping Method is Expedited | The Customer's Phone |
CustomerId | String | 100 | Merchants Unique Id for Recipient | |
Notes | String | 250 | Memo Field on Check | |
CustomField1 | String | 100 | Company: This is the company name of the recipient. If this field is set, it will be printed on the check as TO THE ORDER OF | |
CustomField2 | String | 256 | Print on Check Name: If this field is set, it will be printed on the check as TO THE ORDER OF instead of the recipient’s name or the company name | |
CustomField3 | String | 256 | Message On Check: This message will be displayed on the banner part of the check when the value is passed. | |
CustomField4 | String | Required | Bank Nickname: The Nickname of the bank account. The uploaded checks will be issued from the bank account identified by the Bank Nickname. This is the name you provided during setup. | |
CustomField5 | Bool | Expedited | ||
CustomFiled7 | String | 100 | Required | First Name: Can be Blank when the Company Name is passed |
CustomFiled8 | String | 100 | Required | Last Name: Can be Blank when the Company Name is passed |
Request Samples
/EPNAPI/ACHXML.aspx
Request
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <Credit xmlns="https://www.CheckGateway.com/EpnWebServices/Transaction.asmx"> <Version>1.4.2.34</Version> <ResponseXML>1</ResponseXML> <Login>{Merchant Login}</Login> <Password>{Merchant Password}</Password> <ReferenceNumber>968767</ReferenceNumber> <OriginateDate>2024-09-05</OriginateDate> <Amount>2.0</Amount> <Phone>6177014836</Phone> <Notes>checkflotest</Notes> <Address1>25 S Arizona Pl</Address1> <Zip>02141</Zip> <State>MA</State> <City>Cambridge</City> <CheckNumber>702</CheckNumber> <Addenda>{ "test": true }</Addenda> <CustomField1>Test Company Ltd.</CustomField1> <CustomField2>Name on check</CustomField2> <CustomField3>Message on check</CustomField3> <CustomField4>c119c1e9-c6fb-11ee-aa35-02c83e01e179</CustomField4> <CustomField5>true</CustomField5> <CustomField6>c119c1e9-c6fb-11ee-aa35-02c83e01e179</CustomField6> <CustomField7>test</CustomField7> <CustomField8>checkflo</CustomField8> <PaymentType>CF</PaymentType> </Credit> </soap:Body> </soap:Envelope>
Response
<?xml version="1.0" encoding="utf-8"?> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <soap:Body> <CreditResponse xmlns="https://www.CheckGateway.com/EpnWebServices/Transaction.asmx"> <CreditResult><?xml version="1.0"?> <Response Method="Credit" Version="v1_4_2_00" Success="True" Severity="0" TransactionID="1158"> <CheckNumber>702</CheckNumber> <CheckTranId /> <CheckPaymentDate>9/5/2024 12:00:00 AM</CheckPaymentDate> <TransactionStatus>Pending</TransactionStatus> </Response></CreditResult> </CreditResponse> </soap:Body> </soap:Envelope>