Getting Started

Introduction

The PixToPay API provides a complete solution for managing instant payments with PIX:

1. API integration

The simplest way to integrate is through our RESTful API, which exposes all the methods you need for cash-in, cash-out, payment management, limits, metrics, and more.

Authentication

To use the API, you need the api_key provided when your account is registered. Every request must include this token in the Authorization: YOUR_API_KEY header.

This key is static; it must not be used as a JWT/OAuth Bearer token. It does not expire, so every request to the API requires the Authorization header.

Example:

curl --location https://sandbox.pixtopay.com.br/v2/pix
--header 'Authorization: YOUR_API_KEY'
...

Next steps

See the Cash-in (opens in a new tab) section to start creating and managing PIX charges.

See the Cash-out (opens in a new tab) section to start creating and managing PIX payouts.

See the Webhooks (opens in a new tab) section to understand the workflow and status changes for each event emitted by the API.