Getting Started

Learn the first steps to begin integrating the Pix Payments API.

To have access to the service, you need to complete the following steps:

  1. Contact our sales team at [email protected] to indicate your interest in the Pix Payments product. Only business users are eligible to have this feature active in their accounts.
  2. Approve the KYC compliance assessment. To complete the KYC process, you must create a Bitso business account (production environment) at the Bitso business register. The only way to access the API is through a Bitso account.

Meanwhile, you can create a testing account and learn about the product:

  1. For further details on creating an account and generating API keys, see the section, Set Up Your Testing Environment
  2. The Pix Payments API requires authenticated requests. Learn how to generate your signed requests in the article Authentication. All of Bitso’s APIs follow the same authentication mechanism and General concepts.
  3. Explore the endpoints' documentation in the section How to Use the Service.
  4. The article Webhooks gets you ready to set up your notification service.
  5. To monitor your account funds, call the endpoint Get Account Balance, which retrieves information related to your account balances for all Bitso-supported currencies.
  1. Sign the Pix Payments contract (offline).
  2. Non-Brazilian users must enable the Brazilian real currency (BRL) in their accounts. Your account manager can help you to have it enabled.
  3. They can also help you ensure your account is listed in the service allowlist.
📘

Going to production?

You must generate new API keys in your prod account when going to production.


Did this page help you?