IOPAY→APIs
Entwicklerplattform

Die API ist der Kern.
Das Erlebnis bleibt Ihres.

Er baut Zahlungen direkt in sein Produkt auf. Eine API REST für Kunden, Karten, Pix, boleto und Kredit mit SDKs, webhooks und dedizierten Referenzen für Transaktions-, Zahlungslinks, Sellers, Zahlungsaufteilung und Ausgabenmanagement.

Beginnen Sie mit der API ↓ Öffnen Sie die Referenz-API —
REST-APISandboxNode.jsPHP / LaravelWebhooksZahlungslinksZahlungsaufteilung
POST /api/v1/transaction/new/:CustomerID
Neue Kreditkartentransaktion
application/json
{
  "amount": 14990,
  "currency": "BRL",
  "description": "Pedido #102938",
  "id_card": "23082eb67cd54e7eb4c9cf8c760bd12f",
  "capture": 1,
  "statement_descriptor": "IOPAY STORE",
  "installment_plan": {
    "number_installments": 1
  },
  "io_seller_id": "<IO_SELLER_ID>",
  "payment_type": "credit",
  "reference_id": "102938"
}
application/json Transaktionsreaktion 
{
  "success": {
    "id": "7f38b2c94e1a4d69a81f53b76d9c204e",
    "resource": "transaction",
    "status": "succeeded",
    "payment_type": "credit",
    "amount": "149.90",
    "captured": true,
    "currency": "BRL",
    "reference_id": "102938",
    "payment_method": {
      "resource": "card",
      "card_brand": "Visa",
      "last4_digits": "4242"
    },
    "installment_plan": {
      "mode": "interest_free",
      "number_installments": "1"
    },
    "created_at": "2026-10-06T20:09:48+00:00"
  }
}
Karte ohne Datenrückgewinnung.Verwenden Sie id_card bereits mit customer verbunden und erstellen Sie die Transaktion.
IOPAY-Dokumentation

APIs und dokumentierte und organisierte Integrationsreferenzen

Erweitern Sie die Zahlungsprodukte und -dienste als Dienstleistung. Beginnen Sie mit API Basis und gehen Sie zur spezifischen Referenz Ihrer Implementierung voran. Transaktional, Zahlungslinks, Sellers, Zahlungsaufteilung, Anfragen, Tokenisierung und Ausgabenmanagement werden organisiert, wenn Sie schnell zum richtigen Referenz kommen.

docs-api.iopay.com.br
Öffentliche Dokumentation
Basis-API

Die Grundlage ihrer Integration.

Er beginnt mit Authentifizierung, Umgebung, Kunden, Karten und Tokenierung. Die Transaktionsschicht geht in den nächsten Schritt.

Öffnen Sie die Referenz-API —
StiftungBasis-API
AUTHBearer tokenZugriff
POSTv1/customer/newKunde
POSTv1/card/tokenize/tokenTokenize
ENVsandbox / productionUmgebungen
Transaktions-API

Von der erstellten Zahlung bis zum gesamten Transaktionszyklus.

Konzentrieren Sie sich hier auf die Transaktionsvorgänge von Pix, Karte und boleto: Erstellung, Abfrage, Festnahme, Stornierung, Rückgabe und Statusüberwachung.

Öffnen Sie Transaktions-API —
ZahlungenTransaktions-API
POSTv1/transaction/new/:CustomerIDErstellen
GETv1/transaction/get/:idAbfragen
CAPcaptura total ou parcialDas Gefangen
VOIDcancelamento / estornoZyklus
Postman · Payment Links API V2

Verwandeln Sie eine Abrechnung in eine URL.

API V2 umfasst die Erstellung, Abfrage, Aktualisierung, Löschung und Auflistung von Links sowie die Abfrage der erzeugten Transaktionen. Setzen Sie Elemente, Zahlungsmittel, Abteilung, Zinsen, Verfügbarkeit, Order Bump, visuelle Identität und Split ein, wenn sie aktiviert sind.

Öffnen Sie die V2-Dokumentation — Referenz V1 —
V2 - KonfigurationZahlungsverbindung
ITEMtitle + items[]Zahlungsanforderung
PAYcredit / pix / boletoMethoden
TIMEopen_at / end_at / max_paymentsVerfügbarkeit
CARDmax_installment + interestRatenzahlung
BUMPorder_bump_items[]Zusätzliches Angebot
BRANDprimary_color + bannersIdentität
SPLITsplit_rules[]Verteilung
Postman · Sellers API

Teilnehmer, die als Teil der Architektur behandelt werden.

Siehe die spezifische Referenz zur Implementierung von Sellers-basierten Funktionen der Plattform und zur Aufrechterhaltung dieser Transactional-Kern-Schicht.

Öffnen Sie Sellers im Postman —
Postman öffentliche Sammlung
Sellers APITeilnehmer der Plattform
Postman · Zahlungsaufteilung

Split von Zahlungen mit eigenem Referenz.

Verwenden Sie die dedizierte Sammlung, um Zahlungsaufteilung-Regelungen in mehrfach teilnehmenden Operationen zu implementieren, wobei diese Schicht vom API-Basis und Transaktions-API-Basis getrennt bleibt.

Öffnen Sie die Zahlungsaufteilung in Postman —
Postman öffentliche Sammlung
ZahlungsaufteilungDie Zahlungsaufteilung-Regeln
Ausgabenmanagement und Unternehmenskarten

Unternehmenssteuerung, die mit der Plattform verbunden ist.

Eine Front für die Ausgabe und Verwaltung von Unternehmenskarten, die Grenzwerte, die Nutzungspolisien, die Träger und die Überwachung der Ausgaben.

Öffnen Sie die Kostenverwaltung —
UnternehmenUnternehmenskarten
CARDemissão e gestão por empresaKarten
RULElimites e políticas de usoKontrolle
TEAMportadores e centros de custoTeam
VIEWvisão consolidada de gastosBetrieb
Quickstart

Der erste Antrag
auf die erste Abgabe.
In drei Schritten.

Setzen Sie die Authentifizierung ein, erstellen Sie customer und erstellen Sie eine Pix-Investition mit dem gleichen Fluss, den Ihre Anwendung zur Produktion führt.

Erste Integration

Ein kurzer Weg, um die Struktur von API zu verstehen, bevor wir die anderen Ressourcen erforschen.

Öffnen Sie die Referenz-API —
01
Aktive SchrittAuthentifizieren von Anfragen
Schritt 1 · Zugang

Authentifizieren von Anfragen

Jede Integration beginnt mit der richtigen Umgebung und einem gültigen Token im Autorization-Header.

Bearer tokenSandboxProduktion
Ziel

Ihre Anwendung wird mit API IOPAY authentifiziert sprechen.

Erwarteter Rückkehr

Von hier aus können Sie die nächsten Integrationsrouten nennen.

Wo kommt er rein?

Zu Beginn jeder Integration, bevor Sie Kunden oder Transaktionen erstellen.

Checkliste
  • Wählen Sie Sandbox oder Produktion.
  • Hinzufügen Authorization: seu_token.
  • Inhalt-Typ: Anwendung/json.
Beispiel für Authentifizierung
Docs — 
curl --request GET \
  --url https://api.iopay.com.br/api/v1/customer/get/:customerId \
  --header 'Authorization: Bearer seu_token' \
  --header 'Content-Type: application/json'
Nächster Schritt

Mit der Authentifizierung ist der nächste Schritt, den Käufer zu erstellen, der die Gebühr bekommt.

Authorization: Bearer seu_token





Zahlungsmittel

Eine Integration.Jedes Zahlungstück
Ihre eigene Reise.

Pix, Karte und boleto leben im Transaktionskern. Zahlungslinks hat die gleiche Infrastruktur für Assisted Sales, Remote Charging und Channels ohne eigene Checkout.

PIX

Pix

Erstellung von Instant Charges, QR Code und Veranstaltungsbestätigungsüberwachung.

Ideal für Checkout, Remote-Bebühren und Sofortzahlungen.
CC

Karten

Kreditkartenzahlung ohne Raten oder Partitions-, Tokenisierungs- und Wiederkauf- oder Wiederholungsreisen.

Er ermöglicht die Kombination von Eigen-Checkout mit den Genehmigungsflüssen für die Operation.
BLT

Boleto

Erteilung und Beobachtung von Reiseabgaben, die eine Zahlung durch Titel erfordern.

Die Erhebungssituation kann in die interne Prozesse des Unternehmens integriert werden.
LNK

Zahlungslinks

Erstellen Sie gehostete und teiltelige Gebühren für API für Verkauf ausserhalb des traditionellen Checkouts.

CRM, WhatsApp, Innenvertrieb, Service und geassistierte Zahlungsabläufe.


Webhooks & Veranstaltungen

Ihr System muss nicht fragen.
Iopay wird in Sekunden aufmerksam machen.

HTTP POST Echtzeit Keine Umfrage

IOPAY erhält das Zahlungs-Update, verarbeitet den neuen Status und sendet webhook an sein Endpunkt. Wenige Reibung, klarer Fluss und synchronisierte Systeme.

Bereitstellung der webhooks-Layer und resilienten Iopay-Ereignisse mit automatischer Rückgabe bei serverunverfügbarkeit.

01 · Ursprung Die Zahlung ändert sich.

Neuer Stand der Infrastruktur.

→→→→→→→→→→→→→→
03 · Ihr System Die webhook Das ist genug. Immer.

Ihr Endpunkt erhält die POST-Anfrage von Iopay und Sie verarbeiten und reagieren wie Sie wollen. Ihr System ergreift Massnahmen nach einer Erstellung, Genehmigung, Versagen, Entrichtung oder teilweise Beendigung einer Zahlung. Mit dem Verlust hat Ihr System alles, um den Auftrag freizusetzen, CRM & ERPs zu speisen, mit SAP zu interagieren, Fullfilment und Steuerbericht zu integrieren.

SDKs IOPAY

SDKs für Java, Javascript, Node.js und
PHP / Laravel.

Verwenden Sie die öffentlichen IOPAY-Clients in Node.js und PHP / Laravel oder integrieren Sie sie direkt durch API REST in jeder Sprache. Weniger Boilerplate, um zu beginnen, ohne den Zugang zu HTTP-Plattformvertrag zu verlieren.

Offizieller SDK · Node.js

Bereite Integration für JavaScript-Anwendungen.

Öffentlicher Client mit Authentifizierung, Umgebungen, Tokenisierung, Kunden und Haupttransaktionsgeschäften.

Siehe auf GitHub —
Installation 
npm install
@iopay-payments/iopay-api-sdk-nodejs

// depois, use o client IOPAY no projeto
Offizieller SDK · PHP

Komponist für PHP oder Laravel-Projekte.

Das offizielle Paket iopay-payments/sdk-php kann über Composer installiert und für den Autoload des Projekts eingesetzt werden, auch in Laravel Anwendungen.

Siehe auf GitHub — Packagist —
Installation über Composer 
composer require
iopay-payments/sdk-php

// disponível no vendor/autoload.php do projeto
REST API · jeder Stack

Nutzen Sie HTTP direkt, wenn Sie die volle Kontrolle haben.

Python, Go, Java, .NET, Ruby oder jeder andere Stack können API IOPAY direkt über HTTPS verbrauchen, indem sie die gleichen veröffentlichten Endpunkte und Verträge verwenden.

Öffnen Sie die Referenz-API —
Ein universelles Beispiel 
curl --request GET \\
  --url https://api.iopay.com.br/api/v1/customer/get/:CustomerID \\
  --header 'Authorization: Bearer seu_token' \\
  --header 'Content-Type: application/json'
Betrieb

Integration und Betrieb müssen die gleiche Sprache sprechen.

Nach dem Einsatz müssen Engineering, Produkt, Finanzen und Service die gleiche Zahlung sehen. Das IOPAY-Portal ergänzt API mit Transaktionssicht, Einnahmen, Anmeldeinformationen, Berichten und operativer Überwachung.

01Transaktionen Siehe Status, Kunde, Methode, Wert und Referenzen für die Operation.
02Forderungen Verfolgen Sie die finanzielle Sichtweise der verarbeiteten Verkäufe.
03Zugangsdaten Zentralisieren Sie die Daten, die für Integrationsumgebungen erforderlich sind.
04Berichte Unterstützen Sie die Operations- und Vermittlungsroutinen ohne sich nur auf das Engineering Team zu verlassen.
Operation IOPAYKonsolidierte Sichtweise
TRANSAKTIONEN883
GENEHMIGUNG60,4%
TPVR$ 2,58 Mio.
TransaktionMethodeStatusBetrag
0b527...9a6creditGeprüftR$ 1.002
44d23...9044pixAufhängigR$ 3.482
34fad...29e7creditGeprüftR$ 5.444
Sicherheit & Architektur als Kern und Grundprinzip

APIs und Architektur für die Arbeit
Zahlungen mit Kontrolle, Sicherheit und Sicht.

Anschluss, Umgebungssegregation, Tokenisierung und Sicherheitskontrollen sind Teil der Produktarchitecture und reduzieren die unnötige Exposition gegenüber sensiblen Daten.

01Segregate Credentials

Trennen Sie Entwicklung, Test und Produktion mit entsprechenden Qualifikationen für jedes Umfeld.

02Tokenisierung

Verringert den Umlauf von sensiblen Daten in Re-Käufen, Re-Käufen und One-Click-Trägern.

03PCI DSS 4.0.1

Sicherheitskontrollen und Umweltschutz für Zahlungen, die auf die Infrastruktur IOPAY angewendet werden.

04Ereignisse und Rückverfolgbarkeit

Verwenden Sie Identifikatoren, Status und webhooks um den Transaktionszyklus zu verfolgen und auf Ausnahmen zu reagieren.

Verwendungsfälle

Architektur für verschiedene
Geschäftsmodelle.

Die Developer Platform IOPAY wurde für Produkte entwickelt, die Zahlungen in das E-Commerce-Erlebnis selbst auf SaaS, Marketplace, ERP und Assisted Sales einbinden müssen.

E-Commerce

Ich habe einen eigenen Checkout.

Steuern Sie die Erfahrung des Käufers, während IOPAY die Layer von Zahlungen und Events ausführt.

Siehe E-Commerce →
SaaS & Wiederholung

Erholung und fortlaufende Abrechnung.

Kombiniert Tokenisierung, Kunden, Events und Logik Ihrer Anwendung für wiederkehrende Zahlungsabläufe.

Siehe Dokumentation →
Marketplaces

Sellers und Zahlungsaufteilung.

Sie berücksichtigt den Kontext von Sellers und den Vorschriften von Zahlungsaufteilung für den Transaktionsfluss.

Siehe Marktplätze →
ERP & Finanzen

Zahlungen, die mit der Operation verbunden sind.

Integrieren Sie Abrechnungen und Events in interne Konzentrations-, Abhilfemassnahmen- und Finanzprozesse.

Mit einem Fachmann sprechen →
Inneres Verkauf

Einholung in den Funnel.

Verwalten Sie Links oder Transaktionen aus dem CRM und geben Sie Status für Verkauf, Onboarding und Finanzen zurück.

Siehe Links →
White-Label

Infrastruktur in Ihrer Erfahrung.

Kombinieren Sie APIs und Plattform-Funktionen, um integrierte Zahlungsverkehrsdienste in Ihre Marke zu bieten.

Siehe white-label →



Technische Inhalte

Um ihre Integration zu fördern
von der ersten Aufforderung zur Produktion.

Vier Bloglesungen aus dem IOPAY ausgewählt für die, die Zahlungsintegrationen, Asynchronenveranstaltungen, Sicherheit und Entwicklererfahrung entwerfen.

Architektur & Produktion

Wie Sie Zahlungen in Ihr System über API integrieren

Sandbox bis Go-Live: Status, Zeitlosigkeit, Rückzugsfälle, Reihenfolge, Beobachtbarkeit, Konzilierung und Behandlung von Ausnahmen in der Produktion.

Lesen Sie einen Artikel↗
 Webhooks & Veranstaltungen

Zahlungs-Webhooks: Sicherheit, Störung und Rückzugsfälle

Wie man Ereignisse sicher empfängt, mit Doppelzahlungen, Verzögerungen, Rücksendungen umgeht und den Status der Anwendung konstant hält.

Lesen Sie einen Artikel↗
 Entwicklererfahrung

SDK oder API REST für Zahlungen: Welches zu wählen?

Vergleiche Implementierungsgeschwindigkeit, Kontrollniveau, Versionalisierung, Wartung, Beobachtbarkeit und Portabilität zwischen den Ansätzen.

Lesen Sie einen Artikel↗
 API-Sicherheit

Sicherheit von Zahlungs-APIs

Authentifizierung, Geheimnisse, Rate Limiting, Zeitverwaltung, Zulassung und Kontrollen sind essentiell, um eine finanzielle Integration zu schützen.

Lesen Sie einen Artikel↗
Mehr zu APIs —
Integration und APIs IO

Von der ersten Anrufe zur Produktion. Sie haben die beste Architektur für Zahlungslösungen

Explorieren Sie die Dokumentation, testen Sie ihre Integration und leichten Sie Zahlungen mit der IOPAY Infrastruktur in Ihr Produkt.

Konto eröffnen ↗API-Referenz