About REST API
REST or RESTful API design (Representational State Transfer) is designed to take advantage of existing protocols. While REST can be used over nearly any protocol, it usually takes advantage of HTTP when used for Web APIs. This means that developers do not need to install libraries or additional software in order to take advantage of a REST API design. REST API Design was defined by Dr. Roy Fielding in his 2000 doctorate dissertation. It is notable for its incredible layer of flexibility. Since data is not tied to methods and resources, REST has the ability to handle multiple types of calls, return different data formats and even change structurally with the correct implementation of hypermed
Action Codes
The payment API carries a deep, rich set of function to support many business types and needs. We have implemented "ACTION CODES" to allow you to expand the API to your specific needs. This allows you to generate Payments with a minimum DATA SET.
Authentication
EdgePay supports HTTP Basic authentication. This allows you to protect the URLs on your web server so that only you and EdgePay can access them. In order to authenticate with HTTP, you may provide a username and password with the following URL format:
| Merchant ID | Terminal I | Merchant API Key |
|---|---|---|
| 6320340123456900 | 88800000282601 | E3DFE3D0150EB516F4E351CE7FE5A2FB799B320BDC5D523B |
Host Based-Time Initiated
The system is "HOST BASE, TIME INITIATED" for processing clearing (collecting payments from card holders or check writers) and settlement (paying collected funds to merchants). At merchant configuration we set a cutoff time and all approved transactions with a capture delivered will be processed for payment and settlement.
Duplicate Checks
The service uses an "externalReferenceID" in the header that you set for duplicate checking. If you use the same externalReferenceID within a 3-day period, EdgePay will decline the transaction.