Vom Firmenkonto bis zur Ausgabenverfolgung.
Die API gliedert den Unternehmensbetrieb in getrennte Ressourcen und hält Konto, Karteninhaber, Karten, Käufe, Abrechnungen und Analysen im selben öffentlichen Vertrag.
Konto, Saldo und Limit.
Fragen Sie Kontostatus und Verfügbarkeit ab und beantragen Sie Limit-Aufladungen.
Karteninhaber und Karten.
Legen Sie Karteninhaber an, geben Sie virtuelle oder physische Karten aus und wenden Sie Nutzungsregeln an.
Käufe, Abrechnungen und Analysen.
Verfolgen Sie Ausgaben, Kostenstellen, Abrechnungen und analytische Gruppierungen.
Status des Firmenkontos
Die Aktivierung erfolgt nicht über die öffentliche API. Der Endpunkt GET /corporate/cards/account bleibt in jedem Status verfügbar, um den aktuellen Stand der Ressource abzufragen.
Aktivierung noch nicht beantragt.
Der aktualisierte Vertrag muss im IOPAY-Konto akzeptiert werden.
Antrag in Prüfung durch das IOPAY-Team.
API-Vorgänge verfügbar.
suspended zeigt an, dass die Ressource für das Konto nicht verfügbar ist.Grundablauf
Bestätigen Sie, dass die Ressource active ist.
Legen Sie Identität, Limit, Intervall und Kostenstelle fest.
Wählen Sie Typ, Limit und gegebenenfalls Händlerbeschränkung.
Nutzen Sie Käufe, Abrechnungen, Kostenstellen und Analytics.
Karteninhaber anlegen
{
"name": "NOME HOLDER",
"tax_id": "12345678909",
"amount": 1000,
"interval": "month",
"center_cost": "MeuCenterCost"
}Karte erstellen
{
"holder_id": "{{holder_id}}",
"name": "Google Ads",
"limit": 100000,
"interval": "month",
"type": "virtual",
"merchant": "GOOGLE"
}merchant legt eine Händlerbeschränkung fest, nicht den Kartennamen. Verwenden Sie name als interne Kennung. Wird merchant weggelassen oder null gesendet, wird über dieses Feld keine Beschränkung gesetzt.Ressourcen und Endpunkte
| Bereich | Vorgänge | Hauptroute |
|---|---|---|
| Konto | Status, Saldo, Limit und Aufladung. | /corporate/cards/account · /balance · /recharge |
| Karteninhaber | Auflisten, abfragen, erstellen, aktualisieren und kündigen. | /corporate/cards/holders |
| Karten pro Karteninhaber | Karten und Käufe eines Holders abfragen. | /holders/{holder_id}/cards · /purchases |
| Karten | Auflisten, abfragen, erstellen, aktualisieren und sensible Daten abrufen. | /corporate/cards · /{card_id}/secrets |
| Käufe | Gesamtliste sowie nach Karte/Karteninhaber. | /corporate/cards/purchases |
| Kostenstellen | Gruppierte Ausgaben und Details der Kostenstelle. | /corporate/cards/cost-centers |
| Abrechnungen | Auflisten, Fälligkeit ändern und Zahlung erzeugen. | /corporate/cards/invoices |
| Analytics | Zusammenfassung und Gruppierungen der Ausgaben. | /corporate/cards/analytics |
Limits, Karteninhaber und Kostenstellen
Limit nach Regel.
Der Holder erhält amount und das Intervall day, week oder month.
Virtuell oder physisch.
Ordnen Sie die Karte dem Karteninhaber zu und legen Sie bei Bedarf Limit, Intervall und Händlerbeschränkung fest.
Kontext für den Betrieb.
Gruppieren Sie Ausgaben und fragen Sie Käufe, Beträge und Cashback pro Kostenstelle ab.
Resources und Paginierung
Erfolgsantworten identifizieren die Ressource über resource. Auflistungen verwenden eine standardisierte Hülle mit items, limit, total, offset, has_more und query_count.
{
"resource": "list",
"sort": "time-descending",
"items": [],
"limit": 100,
"total": 0,
"offset": 0,
"has_more": false,
"query_count": 0
}limit und offset werden in Auflistungen unterstützt. Das Standardlimit ist 100, das Maximum 1000. Bei kompatiblen Abfragen aktualisiert ?refresh=true die IOPAY-Basis vor der Antwort mit den neuesten Daten der ausgebenden Bank.Abrechnungen und Ausgabenanalysen
Fälligkeit und Zahlung.
Listen Sie Abrechnungen auf, legen Sie den Fälligkeitstag zwischen 1 und 28 fest und erzeugen Sie die Zahlungsdaten der Abrechnung, die brcode und link enthalten können.
Konsolidierte Ausgaben.
Fragen Sie Gesamtausgaben, Anzahl der Käufe, Cashback und Gruppierungen nach Kategorie, Kostenstelle, Karteninhaber und Monatsverlauf ab.
Kartendaten
Der Endpunkt GET /corporate/cards/{card_id}/secrets gibt PAN, CVV, Ablaufdatum und TTL zurück, wenn dies für den Vorgang nötig ist.
Öffentliche Collection
Die Collection bündelt die 23 dokumentierten Endpunkte sowie Erfolgs- und Fehlerbeispiele für relevante Abläufe zu Konto, Aufladung, Karteninhabern und Betrieb.