Eine API für den kompletten Lebenszyklus des Links.
Mit V2 können Sie Zahlungslinks erstellen, abfragen, aktualisieren, löschen und auflisten sowie die über diese Links entstandenen Transaktionen abfragen.
Artikel, Order Bump und Identität.
Konfigurieren Sie Artikel, optionale Angebote, Primärfarbe und bei Bedarf ein Banner.
Raten, Zinsen und Nutzung.
Legen Sie Raten, Zinsweitergabe, Verfügbarkeitsfenster und maximale Anzahl an Zahlungen fest.
Abfragbare Links und Transaktionen.
Listen Sie Zahlungsanforderungen auf und filtern Sie die erzeugten Transaktionen nach Status, Methode, Zeitraum und Link.
Einen Zahlungslink erstellen
Die Werte von items[*].amount und order_bump_items[*].amount werden in Cent angegeben. Der Hauptbetrag ergibt sich aus der Summe der Artikel; Order Bumps sind im Anfangsbetrag nicht enthalten.
Gehen Sie in den folgenden Beispielen von BASE_URL = https://api.iopay.com.br/api aus.
{
"title": "Bestellung #1001",
"description": "Compra de produtos diversos",
"status": "enabled",
"open_at": null,
"end_at": null,
"max_payments": 1,
"max_installment": 3,
"highlight_installment_condition": true,
"enabled_payment_methods": {
"credit": true,
"pix": true,
"boleto": true
},
"pass_interest_to_customer": true,
"customer_interest_starts_at_installment": 1,
"primary_color": "4099b4",
"items": [
{
"name": "Produto principal",
"amount": 60000
}
],
"order_bump_items": [
{
"name": "Garantia estendida",
"amount": 15000
}
]
}credit, pix und boleto. Mindestens eine Methode muss aktiviert und für das authentifizierte Konto freigegeben sein. debit ist für Zahlungslinks nicht verfügbar.Funktionen der V2
| Funktion | Hauptfelder | Verwendung |
|---|---|---|
| Artikel | items[] | Produkte, die den Anfangsbetrag des Links bilden. |
| Order Bump | order_bump_items[] | Im Checkout angebotene optionale Artikel. |
| Methoden | enabled_payment_methods | Kredit, Pix und Boleto entsprechend der Freischaltung des Kontos. |
| Ratenzahlung | max_installment · highlight_installment_condition | 1 bis 12 Raten, gemäß der Kontokonfiguration. |
| Zinsen | pass_interest_to_customer · customer_interest_starts_at_installment | Steuerung der Zinsweitergabe an den Käufer. |
| Verfügbarkeit | open_at · end_at · max_payments | Zeitfenster des Links und Nutzungslimit. |
| Identität | primary_color · banners | Primärfarbe und optionales Checkout-Banner. |
| Split | split_rules[] | Prozentuale oder feste Verteilung für aktivierte Konten. |
Erstellung mit visueller Identität
Um ein Banner zu senden, verwenden Sie multipart/form-data am selben Erstellungs-Endpunkt. Verwenden Sie nur banners[left] oder banners[right].
JPEG · PNG · WebP
Bei der Erstellung mit Banner akzeptierte Formate.
Bis zu 5 MB.
Maximale Abmessung 4096×4096 und bis zu 16 MP.
Automatische Boundary.
Setzen Sie den Content-Type bei Multipart in Postman nicht manuell.
Endpunkte
| Methode | Route | Betrieb |
|---|---|---|
| POST | /v2/payment_link | Link in JSON erstellen. |
| POST | /v2/payment_link | Link mit Banner per Multipart erstellen. |
| GET | /v2/payment_link/{ID_LINK} | Einen Link abfragen. |
| PATCH | /v2/payment_link/{ID_LINK} | Teilweise aktualisieren. |
| DELETE | /v2/payment_link/{ID_LINK} | Einen Link löschen. |
| GET | /v2/payment_link/list | Links mit Filtern und Paginierung auflisten. |
| GET | /v2/payment_link/list/transactions | Über Links entstandene Transaktionen auflisten. |
Operative Auflistungen
Filtern Sie den Bestand an Zahlungsanforderungen.
page, limit, offset, sort, status und Erstellungszeitraum über date_range.
Finden Sie die richtige Zahlung.
Neben Paginierung und Zeitraum filtern Sie nach id_link, status und payment_type.
order_bump_items: [] entfernt die Order Bumps; split_rules: [] entfernt die Split-Regeln; primary_color: null stellt das Standarddesign wieder her.V2 für neue Integrationen. V1 für Kompatibilität.
Developer Central hebt V2 als aktuelle Referenz hervor. Bestehende Integrationen, die noch vom früheren Vertrag abhängen, können weiterhin die öffentliche V1-Dokumentation nutzen.