Overview
Overview
The API Base focuses on the main stream of payments: authentication, customers, cards/tokenization and transactions. Sellers and Split have their own surfaces because they serve platform and distribution operations.
Reusable identity.
Create the buyer once and reuse the context on new journeys.
Create and track payments.
Pix, card and boleto enter the same transaction cycle as API.
Less exposure.
Associate payment instruments with customer for recurring journeys and repurchase.
Authentication
Authentication
Send a valid token to the header Authorization and use JSON in the integration payloads.
Example of authentication
curl --request GET \ --url https://api.iopay.com.br/api/v1/customer/get/:customerId \ --header 'Authorization: Bearer seu_token' \ --header 'Content-Type: application/json'
Ambientes. Separate development/testing and production credentials. Do not display tokens in the frontend, repository or public logs.
Quick start
Basic flow
Choose the environment and send the Bearer token.
You get a reusable ID for the trip.
Create Pix, card or boleto associated with customer.
Use ID and webhooks to keep up with changes.
Creating a customer
POST /api/v1/customer/new
curl --request POST \
--url https://api.iopay.com.br/api/customer/new \
--header 'Authorization: Bearer seu_token' \
--header 'Content-Type: application/json' \
--data '{
"name": "Maria Oliveira",
"email": "[email protected]",
"document": "12345678909",
"phone_number": "+5511999999999"
}'Creating Pix transaction
POST /api/v1/transaction/new/:CustomerID
curl --request POST \
--url https://api.iopay.com.br/api/v1/transaction/new/:CustomerID \
--header 'Authorization: Bearer seu_token' \
--header 'Content-Type: application/json' \
--data '{
"amount": 12990,
"payment_method": "pix",
"reference_id": "order_102938"
}'Examples of integration. Keep routes, fields and examples in sync with current implementation before posting changes.
Map of resources
Features
| Area | Use | Next reference |
|---|---|---|
| Customers | Register, check and identity of the payer. | Core API |
| Card / tokenization | Instruments associated with the customer and buy back. | Core API |
| Transactions | Creation, consultation, capture and cancellation. | Core API |
| Pix | Charge, identification and status tracking. | The basic API + webhooks |
| Boleto | Creation and cycle of bank collection. | The basic API + webhooks |
| Sellers | Platform/marketplace participants. | Sellers API → |
| Split | Distribution between participants. | Split API |