FAQ

Where is my Sandbox?

Your Sandbox environment is a dedicated testing space where you can safely experiment with our API without affecting live data or production environments.

How to Access Your Sandbox:

If you cannot locate your Sandbox, or if you have any trouble accessing it, please refer to our support team for assistance.

Where is my Bearer token?

A Bearer token is a key element in authenticating API requests, allowing secure communication between your application and our API.

How to Obtain Your Bearer Token.

What does base_url mean?

The base_url is a fundamental part of working with APIs. It represents the root URL for all API endpoints that you’ll be interacting with.

Understanding base_url:

Root Address: The base_url serves as the root or main address for the API. All the specific API endpoints you interact with will be appended to this root URL.

For example, if the base_url is <https://api.payarc.net/v1>, and you want to access the users endpoint, your full request URL would be:

https://api.payarc.net/v1/users

Consistency: The base_url provides a consistent starting point for all your API requests. You don’t need to repeat the root part of the URL for every request—just append the specific endpoint path.

Environment-Specific: Often, the base_url can vary depending on the environment you're working in:

Production Environment: This is the live environment where real data is processed. The base_url might look something like <https://api.payarc.net/v1>.
Sandbox or Development Environment: For testing purposes, you might have a different base_url, such as <https://testapi.payarc.net/v1>, which points to a test environment with simulated data.

How to Use base_url:

API Requests: When making an API request, you combine the base_url with the specific endpoint path you want to access. For example:

GET https://api.payarc.net/v1/users

Dynamic Handling: In many API client libraries or frameworks, you set the base_url once, and then simply specify the endpoint paths in your requests. The library automatically combines the base_url with the endpoint paths.

Example:

If you're fetching user data, your request might look like this:

GET https://api.payarc.net/v1/users/12345

Here, <https://api.payarc.net/v1> is the base_url, and /users/12345 is the endpoint path.

Test Cards

The table below contains PANs that fit both the respective card ranges. They will not work in Production to produce non-declines. They are ONLY for testing purposes with the TSYS Cert box.

Note the AVS data is in the table below.

AVS data

• Address: 8320
• Zip: 85284

Traditional Response Codes

The Traditional response code indicates the status of a transaction. The table below identifies the response code and the description.

Payfac Response Codes

The Payfac response code indicates the status of a transaction. The table below identifies the response code and the description.

What is an Idempotency Key and when should I use it?

An Idempotency Key is a unique value used in the Idempotency-Key header to prevent duplicate operations, such as creating the same charge more than once. If a request is retried due to a timeout or error, the same key can be used to ensure the server processes it only once, returning the original result instead of performing the operation again.