Überblick
Die Basis-API bündelt den Hauptzahlungsablauf: Authentifizierung, Customers, Karten/Tokenisierung und Transaktionen. Sellers und Split haben eigene Oberflächen, weil sie Plattform- und Verteilungsvorgänge bedienen.
Wiederverwendbare Identität.
Legen Sie den Käufer einmal an und nutzen Sie den Kontext in neuen Abläufen wieder.
Zahlungen erstellen und verfolgen.
Pix, Karte und Boleto laufen im selben Transaktionszyklus der API.
Weniger Offenlegung.
Ordnen Sie dem Customer Zahlungsinstrumente für wiederkehrende Zahlungen und Wiederkauf zu.
Authentifizierung
Senden Sie email, secret und io_seller_id, um das access_token zu erhalten. Verwenden Sie das zurückgegebene Token im Header Authorization der nächsten Requests.
curl --request POST \
--url https://api.iopay.com.br/api/auth/login \
--header 'Content-Type: application/json' \
--data '{
"email": "your_email",
"secret": "your_secret",
"io_seller_id": "<IO_SELLER_ID>"
}'access_token, token_type, token_scope und expires_in zurück. Verwenden Sie das Access Token als Authorization: Bearer your_token in den nächsten Aufrufen und legen Sie Zugangsdaten oder Tokens nicht im Frontend, Repository oder in öffentlichen Logs offen.Grundablauf
Senden Sie Ihre Zugangsdaten und erhalten Sie das Access Token.
Erhalten Sie eine wiederverwendbare Kennung für den Ablauf.
Erstellen Sie Pix, Karte oder Boleto, verknüpft mit dem Customer.
Nutzen Sie Abfragen per ID und Webhooks, um Änderungen zu verfolgen.
Customer anlegen
curl --request POST \
--url https://api.iopay.com.br/api/v1/customer/new \
--header 'Authorization: Bearer your_token' \
--header 'Content-Type: application/json' \
--data '{
"first_name": "Maria",
"last_name": "Oliveira",
"customer_type": "person_natural",
"email": "[email protected]",
"taxpayer_id": "12345678909",
"phone_number": "+5511999999999",
"address": {
"line1": "Av. Paulista, 1000",
"line2": "Apto 101",
"neighborhood": "Bela Vista",
"city": "São Paulo",
"state": "SP",
"postal_code": "01310100",
"country_code": "BR"
}
}'Pix-Transaktion erstellen
curl --request POST \
--url https://api.iopay.com.br/api/v1/transaction/new/:CustomerID \
--header 'Authorization: Bearer your_token' \
--header 'Content-Type: application/json' \
--data '{
"amount": 12990,
"currency": "BRL",
"description": "Bestellung #102938",
"statement_descriptor": "IOPAY STORE",
"io_seller_id": "<IO_SELLER_ID>",
"payment_type": "pix",
"reference_id": "order_102938"
}'Ressourcen
| Bereich | Verwendung | Nächste Referenz |
|---|---|---|
| Customers | Registrierung, Abfrage und Identität des Zahlers. | Basis-API |
| Karten / Tokenisierung | Dem Customer zugeordnete Instrumente und Wiederkauf. | Basis-API |
| Transaktionen | Erstellung, Abfrage, Erfassung und Stornierung. | Basis-API |
| Pix | Zahlungsanforderung, Kennungen und Statusverfolgung. | Basis-API + Webhooks |
| Boleto | Erstellung und Zyklus von Bankzahlscheinen. | Basis-API + Webhooks |
| Seller | Plattform-/Marketplace-Beteiligte. | Sellers API → |
| Split | Verteilung zwischen Beteiligten. | Split API → |