Documentation

Integration Guide

Suggest Edits

Introduction

The primary purpose of the PayBrokers Legacy Connector is to streamline the transition for existing integrators using the PayBrokers V4 API to the new V6 environment. The connector facilitates minimal disruption to operations while offering enhanced compliance and features tailored to regulated markets.

To comply with regulated market standards, Legacy Integration introduces the requirement to include end-user banking details in the request payload. This ensures transactions are linked to verified accounts and aligns with compliance protocols, supporting smoother and more reliable processing.

For comprehensive API reference, you can consult:

LEGACYNEW
DOCUMENTATIONhttps://docs-v4.paybrokers.info/https://dev.paybrokers.com

The connector ensures backward compatibility, allowing integrators to continue using familiar V4 API structures while benefiting from the updated V6 infrastructure.

Updating Base URLs

To ensure smooth operation, integrators must update their base URLs and paths as follows:

LEGACYNEW
BASE URLhttps://v4.paybrokers.io/v4https://api.paybrokers.com/v1/partners-int/v4

Obtaining Credentials

To access the new environment, integrators must ensure their credentials are updated. The process for obtaining these credentials includes:

  1. Contacting PayBrokers support or account representatives through [email protected] email
  2. Setting up secure access with the provided API key and token

❗️

Important:

For the connector there is one additional step of creating the webhook criptographic key that differs from https://dev.paybrokers.com/docs/access-credentials and should be included at the end of the process.

Testing in Sandbox

The sandbox environment is designed to support all functionalities of the new API, providing a robust space for testing and validation. Additionally, it includes a dedicated section for legacy integrations.

SANDBOXPRODUCTION
URLhttps://api.sandbox.paybrokers.com/v1/partners-int/v4/https://api.paybrokers.com/v1/partners-int/v4/

Testing Guidelines:

  • Perform authentication tests with sandbox credentials.
  • Test endpoint functionality for cash-in and cash-out operations.
  • Validate the behavior of updated URLs and paths under various scenarios.
  • Please let us know any inconsistencies you have found so we can improve our guides!

Implementing the API

Now that you have tested the sandbox, feel free to go to production environment at:

https://dev.paybrokers.com/reference/connector-auth-token

And in case of any error, you can check our table of errors for the connector:

https://dev.paybrokers.com/docs/connector-errors

Few Tips

👍

End-User Banking Data

Ensure your requests include the required end-user banking details to comply with regulated market standards. This information includes the:

  • Bank code (ISPB)
  • Branch number
  • Account number
  • Account digit

Providing these details ensures transactions are linked to verified user accounts, facilitating smooth processing and adherence to compliance protocols.

🚧

CPF Verification Service

The CPF service is not supported in the new connector yet. To continue utilizing this feature, please ensure you retain and use your existing credentials. The support will be available soon.

Updated 3 months ago