Access Credentials

How can I get my Access Credentials?

To start using the Paybrokers APIs, you’ll need to use you Company login credentials(that you should got with our Technology Team, like apresented in previous guide) for our sandbox Dashboard. Below are the URLs for accessing both sandbox environments:

  • Paybrokers Dashboard URL:

🔗

Sandbox: partners.sandbox.paybrokers.com


API Access Key Creation

First, you need to create an API Access key. To do so, follow the steps bellow:

  1. Access the Administrative Panel and notice that your key will be created for an specific account, seen in the top bar, after checking, click in Administrative.
  1. Click on the Access Key > New Key
  1. Input the access key generation data and click on Generate Keys.


  1. Copy and store the Key and Secret information in a secure place, they will be used in the Paybrokers authentication API.


The generated API Key will be created on a Pending status, and submitted for Paybrokers approval. The generated key will be initially inactive for operation. Please contact a Paybrokers member to approved it and activate it.

Getting an API Token

All API calls are secured through a Bearer access token which uses the JWT (JSON Web Tokens) specification. This technology allows the token to be verified using multiple security criteria such as: expiration, access privileges, integrity check and issuer signature.

  • Default token expiration: 60 minutes. Check the exp attribute of the JWT for expiration details.
  • Ensure your integration requests a new token before the current one expires.

If you encounter any issues during the process of obtaining your access credentials or face any other specific challenges, please reach out to our support team through one of the following channels:


Final Step: Testing Your Credentials

Now that your credentials are set up, it’s time to run a test to verify they are working correctly. Use the Access Key and Access Secret generated in the previous steps and see how it works in Authentication.


What’s Next