Banking & Kartenausgabe

API für Ausgabenmanagement

Integrieren Sie das Konto, den Restbetrag, die Träger, die Kartenemission, die Einkäufe, die Kostenstellen, die Invoice und die Ausgabenanalysen für den öffentlichen API IOPAY.

Url-Basishttps://api.iopay.com.br/api/v1/baas
AuthentifizierungBearer token
UmfangBanking · Unternehmenskarten

Von der Konzernrechnung bis zur Aufsicht über die Ausgaben.

API organisiert die Unternehmensoperation in separaten Ressourcen und hält Konten, Träger, Karten, Einkäufe, Invoice und Analysen im Rahmen des gleichen öffentlichen Vertrages.

Banking

Zählen, Ausgleich und Grenze.

Überprüfen Sie den Status des Kontos, die Verfügbarkeit und beantragen Sie Limit-Refusions.

Ausgabe von Karten

Träger und Karten.

Erstellen Sie Träger, geben Sie virtuelle oder physische Karten aus und setzen Sie Regeln für die Nutzung an.

Verwaltung

Kauf, Rechnungen und Analysen.

Verfolgen Sie Ausgaben, Kostenzentren, Rechnungen und analytische Gruppierungen.

Status des Unternehmenskontos

Die Aktivierung wird nicht durch den öffentlichen API durchgeführt. Endpunkt GET /corporate/cards/account Sie ist in jedem Staat zur Verfügung, um sich mit der aktuellen Situation des Rechtsmittels zu befassen.

01inactive

Noch nicht gefordert.

02waiting_contract_assignment

Der Aktualisierungsvertrag muss im Konto IOPAY angenommen werden.

03pending

Anfrage unter Prüfung durch das IOPAY Team.

04active

Bereitgestellte API-Betriebsarbeiten.

Ativação. Es gibt keinen öffentlichen Endpunkt, um einen Aktivierungsantrag zu beantragen oder einen Vertrag zu akzeptieren. Die Zulassung erfolgt durch den Account IOPAY. Status suspended die für das Konto nicht verfügbare Mittel anzeigt.

Grundfluss

01 · RechnungÜberprüfen Sie den Status.

Bestätigen Sie, dass die Beschwerde active.

02 · TrägerErstellen Sie den Halter.

Definieren Sie Identität, Grenze, Bandbreite und Kostenzentrum.

03 · KarteGib die Karte aus.

Auswahl von Art, Grenze und Einschränkung der Niederlassung, wenn zutreffend.

04 · BetriebBeobachten Sie die Ausgaben.

Verwenden Sie Einkauf, Rechnungen, Kostenzentren und Analytics.

Erstellen von Trägern

POST /corporate/cards/holders
{
  "name": "NOME HOLDER",
  "tax_id": "12345678909",
  "amount": 1000,
  "interval": "month",
  "center_cost": "MeuCenterCost"
}

Erstellen von Karten

POST /corporate/cards
{
  "holder_id": "{{holder_id}}",
  "name": "Google Ads",
  "limit": 100000,
  "interval": "month",
  "type": "virtual",
  "merchant": "GOOGLE"
}
- Die Handelsbeschränkung. merchant Sie definiert eine Einsiedlungsschränkung, nicht den Namen der Karte. Verwenden Sie name als interne Identifizierung. Nicht aufgenommen merchant oder zu senden null Sie definiert keine Beschränkung für dieses Feld.

Ressourcen und Endpunkte

GebietOperationenHauptweg
Es zähltStatus, Ausgleich, Grenzwerte und Aufladung./corporate/cards/account · /balance · /recharge
KarteninhaberListe, Übersicht, Erstellung, Aktualisierung und Stornierung./corporate/cards/holders
Karten pro TrägerKarten und Einkäufe von einem Halter zu überprüfen./holders/{holder_id}/cards · /purchases
KartenListe, Anfrage, Erstellung, Aktualisierung und Anfrage von Sensibeln./corporate/cards · /{card_id}/secrets
KäufeAllgemeine Auflistung und Karten/Täger./corporate/cards/purchases
KostenzentrenAggregate Ausgaben und Einzelheiten des Zentrums./corporate/cards/cost-centers
AbrechnungenListe, Wechsel von Verfall und Zahlung./corporate/cards/invoices
AnalyseZusammenfassung und Ausgabengruppen./corporate/cards/analytics

Grenzen, Träger und Kostenzentren

Karteninhaber

Ein Regelbeschränkung.

Der Halter erhält amount und Abstand day, week oder month.

Karte

Wirklich oder physisch.

Verbinden Sie die Karte mit dem Träger und legen Sie Grenze, Intervall und Merchant Restriction fest, wenn nötig.

Kostenzentrum

Kontext für die Operation.

Geteilt die Ausgaben und prüft Einkäufe, Beträge und Cashback nach Kostenzentrum.

Ressourcen und Paging

Erfolgreiche Antworten identifizieren die Anfrage durch resource. Die Aufzeichnungen verwenden einen standardisierten Umschlag mit items, limit, total, offset, has_more und query_count.

Liste- und Verpackungsumschlag
{
  "resource": "list",
  "sort": "time-descending",
  "items": [],
  "limit": 100,
  "total": 0,
  "offset": 0,
  "has_more": false,
  "query_count": 0
}
Paginação. limit und offset Sie werden in den Listen unterstützt Die Standardgrenze ist 100 und das Maximum ist 1000 In geeigneten Abfragen ?refresh=true die IOPAY-Basis mit den neuesten Daten der Emittentenbank vor der Antwort aktualisiert.

Kostenrechnungen und -analysen

Abrechnungen

Gewinn und Auszahlung.

Liste Rechnung, setze den Verfalltag zwischen 1 und 28 ein und verwalte Zahlungsdaten, die brcode und link.

Analyse

Konsolidierte Ausgaben.

Siehe Gesamtkosten, Anzahl der Einkäufe, Cashback und Kategorie- und Kostenzentrumgruppen, Träger und monatliche Entwicklung.

Kartendaten

Endpunkt GET /corporate/cards/{card_id}/secrets PAN, CVV, Gültigkeit und TTL, wenn für die Operation erforderlich.

Ich benutze ihn pünktlich. Vermeiden Sie die Speicherung oder Aufzeichnung der Antwort dieses Endpunkts. Die Sammlung selbst empfiehlt, diese Daten nur zu erfassen, wenn dies notwendig ist.

öffentliche Sammlung

Die Sammlung bringt die 23 dokumentierten Endpunkte, Erfolgs- und Fehlerbeispiele für relevante Flow-Konten, Überladungen, Träger und Betrieb zusammen.