API Authentication

PAYARC generates an API Access Token for each Merchant Account and the token can be obtained by logging into PAYARC Dashboard (https://www.payarc.net).

Steps to retrieve Bearer Access Token:

Login to PAYARC Dashboard (https://www.payarc.net).
Click on the "API" link in the left navigation bar.
Click on the "Reveal Token" link on the API page.

Your API Access Token carries many privileges, please make sure to keep it secure. Do not share your API Access Token with anyone or on any websites like GitHub, client-side code, etc.
Here is some information that will help you understand the usage of PAYARC API.


Headers

Certain API calls require you to send data in a particular format as part of the API call.
By default, all API calls expect inputs in JSON format, however, you need to ping the server that you are sending a JSON-formatted payload.
In order to do that, you must include the Accept => application/json HTTP header with every call.


Rate limiting

All REST API requests are designed to prevent abuse and ensure stability.
The number of API calls that your application can make per day varies based on the type of request you are making.
The rate limit window is {{rate-limit-expires}} minutes per endpoint, with most individual calls allowing {{rate-limit-attempts}} requests in each window.
In other words, each user is allowed to make {{rate-limit-attempts}} calls per endpoint every {{rate-limit-expires}} minutes (For each unique access token).
You can check the header attributes below to find the number of API calls you can make per minute:


X-RateLimit-Limit → 30
X-RateLimit-Remaining → 29

Pagination

By default, all fetch requests return the first {{pagination-limit}} items in the list. Check the Query Parameters to understand how to control the pagination.
Limit:
The ?limit= parameter can be applied to define how many records should be returned by the endpoint (see also Pagination).

SandBox

PAYARC provides testing environment where merchants could perform test for some business processes without actually perform them in production environment base_url for this environment is https://testapi.payarc.net