Documentation

The Priority Payment Systems API is organized around REST and, is designed to have resource-oriented, predictable and easy-to-use HTTP response codes to indicate API interaction. A testing environment is provided so that, prior to working with live data, testing can be performed to understand the requirements of making successful calls to each API resource. Any payment data submitted in the testing environment will not be transmitted to the credit card networks and will never actually initiate a payment or attempt to move money.

A consumer key and secret are required to complete all API calls so, if you have not yet done so, register as a user and we will promptly contact you with additional instructions on how to begin with our API. As our API can accommodate all of your needs, please enjoy the simplicity of our payment gateway and other very useful functions. For API-related questions or, if you require guidance on how to best utilize the API to suit your business needs, please contact us.

Making The Connection

To connect to, and transact with, the Priority Payment Systems API, a consumer key is required. This is provided by the merchant or, if using our sandbox environemnt, can be obtained by creating a test account. To create a test account, visit our sandbox environment. The Integrating OAuth section demonstrates how to link your consumer key with a merchants information so you can begin building powerful apps!

API Resources

Below is a list of commonly used resources. Take some time to learn about them and this will streamline the integration process.

• Address
• CardAccount
• Customer
• Discount
• Order
• Payment
• Report

View our Full resources list for a more thorough list of resources available.