Purpose of the Merchant Dashboard API

The Merchant Dashboard API provides access to transaction processing information. This API allows partners or merchants to extract ACH, Credit, Authorization, Dispute, Funding and Batch Transaction data to use in another application to meet their reporting requirements.

 

Technology and Knowledge Required

 

The Merchant Dashboard API uses a RESTful (representational state transfer) architectural style. The REST Architecture is not dependent on any protocol, but many RESTful services use HTTP as the underlying protocol including the built-in status codes to indicate API errors. This documentation assumes that you have experience in and knowledge of the REST architecture.

 

To make it easier to interact with the Merchant Dashboard API from PHP applications, we generated code examples and wrapper classes in PHP and provided a link to the code. PHP is not required to use the merchant Dashboard API, but the PHP code is used and explained in this document to provide a Quick Start example. Links to Java and .NET generated code examples are also provided, but the documentation does not refer to those examples.

 

Information extracted using Merchant Dashboard API GET operations is delivered in JSON (Java Script Object Notation). JSON is an open-standard file format using human-readable text for transmitting data. This documentation assumes you have experience and knowledge of JSON.

 

Each GET operation will retrieve a specific type of transaction. To learn which information is returned by each GET operation, see Operations Available in the Merchant Dashboard API.