IOPAY→Entwickler→Basis-API
Haupt-API

Basis-API

Inneres Referenzprogramm für die Organisation des Hauptflusses von API IOPAY: Authentifizierung, Kunden, Zahlungsinstrumente und Transaktionen.

Url-Basishttps://api.iopay.com.br/api/
AuthentifizierungBearer token
FormatJSON
Quickstart Die Ressourcen sehen Webhooks →
Übersicht

Übersicht

Die API Base konzentriert sich auf den Hauptfluss von Zahlungen: Authentifizierung, Kunden, Karten/Tokenisierung und Transaktionen. Sellers und Split haben ihre eigenen Flächen, weil sie Plattform- und Vertriebsbetriebe betreuen.

Kunden

Wiederverwendbarer Identität.

Erstellen Sie den Käufer einmal und nutzen Sie den Kontext auf neuen Zahlungsabläufe wieder.

Transaktionen

Erstellen und verfolgen Sie Zahlungen.

Pix, Karte und boleto Sie sind in den gleichen Transaktionszyklus wie API.

Tokenisierung

Weniger Aufmerksamkeit.

Verknüpfen Sie Zahlungsinstrumente mit customer für wiederkehrende Zahlungsabläufe und Kauf.

Authentifizierung

Authentifizierung

Schicken Sie ein gültiges Token in den Header Authorization und JSON für die Integrations-Payloads verwenden.

Beispiel für Authentifizierung
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. Trennen Sie Entwicklungs-/Test- und Produktions-Kräften. Sie dürfen keine Token im Frontend, im Repository oder in öffentlichen Logs aufstellen.
Quickstart

Grundfluss

01 · ZugangAutentique.

Wählen Sie die Umgebung aus und senden Sie das Bearer-Token.

02 · KundenErstellen Sie den Käufer.

Erhält einen wiederverwendbaren ID für die Reise.

03 · TransaktionSie leitet die Zahlung.

Erstellen Sie Pix, eine Karte oder boleto in Verbindung mit customer.

04 · StaatSincronize.

Nutzen Sie ID- und webhooks-Besuch, um Änderungen zu verfolgen.

Erstellen 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"
  }'

Erstellen von Pix-Transaktionen

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"
  }'
Beispiele für Integration. Halten Sie Routen, Felder und Beispiele mit der aktuellen Implementierung synchronisiert, bevor Sie Änderungen veröffentlichen.
Ressourcenkarte

Funktionen

GebietVerwendungNächster Hinweis
KundenRegistrierung, Anfrage und Identität des Zahlers.Basis-API
Karten / TokenierungDie in diesem Zusammenhang genannten Instrumente customer Und kauft es wieder.Basis-API
TransaktionenErstellen, Abfragen, Fangen und Löschen.Basis-API
PixErhebung, Identifikationsnummern und Statusüberwachung.Basis-API + Webhooks
BoletoErstellung und Zyklus der Bankerhebung.Basis-API + Webhooks
SellersPlattform/Marktplatz-Teilnehmer.Sellers API →
SplitVerteilung zwischen den Teilnehmern.Split API →