Od konta firmowego do śledzenia wydatków.
API porządkuje operacje korporacyjne w osobne zasoby, utrzymując konto, posiadaczy, karty, zakupy, wyciągi i analizy w ramach tego samego publicznego kontraktu.
Konto, saldo i limit.
Sprawdzaj status konta i dostępność oraz składaj wnioski o doładowanie limitu.
Posiadacze i karty.
Twórz posiadaczy, wydawaj karty wirtualne lub fizyczne i stosuj zasady użycia.
Zakupy, wyciągi i analizy.
Śledź wydatki, centra kosztów, wyciągi i grupowania analityczne.
Status konta firmowego
Aktywacja nie odbywa się przez publiczne API. Endpoint GET /corporate/cards/account pozostaje dostępny w każdym stanie, aby sprawdzić bieżącą sytuację zasobu.
Aktywacja jeszcze niezawnioskowana.
Zaktualizowaną umowę należy zaakceptować w Koncie IOPAY.
Wniosek w trakcie analizy przez zespół IOPAY.
Operacje API dostępne.
suspended oznacza, że zasób jest niedostępny dla konta.Podstawowy przepływ
Potwierdź, że zasób jest active.
Określ tożsamość, limit, interwał i centrum kosztów.
Wybierz typ, limit i ograniczenie punktu sprzedaży, gdy ma zastosowanie.
Korzystaj z zakupów, wyciągów, centrów kosztów i analityki.
Utwórz posiadacza
{
"name": "NOME HOLDER",
"tax_id": "12345678909",
"amount": 1000,
"interval": "month",
"center_cost": "MeuCenterCost"
}Utwórz kartę
{
"holder_id": "{{holder_id}}",
"name": "Google Ads",
"limit": 100000,
"interval": "month",
"type": "virtual",
"merchant": "GOOGLE"
}merchant określa ograniczenie punktu sprzedaży, a nie nazwę karty. Użyj name jako identyfikacji wewnętrznej. Pominięcie merchant lub wysłanie null nie ustawia ograniczenia przez to pole.Zasoby i endpointy
| Obszar | Operacje | Główna ścieżka |
|---|---|---|
| Konto | Status, saldo, limit i doładowanie. | /corporate/cards/account · /balance · /recharge |
| Posiadacze | Wyświetlanie, pobieranie, tworzenie, aktualizacja i anulowanie. | /corporate/cards/holders |
| Karty według posiadacza | Pobierz karty i zakupy holdera. | /holders/{holder_id}/cards · /purchases |
| Karty | Wyświetlanie, pobieranie, tworzenie, aktualizacja i pobieranie danych wrażliwych. | /corporate/cards · /{card_id}/secrets |
| Zakupy | Lista ogólna oraz według karty/posiadacza. | /corporate/cards/purchases |
| Centra kosztów | Pogrupowane wydatki i szczegóły centrum. | /corporate/cards/cost-centers |
| Wyciągi | Wyświetlanie, zmiana terminu płatności i generowanie płatności. | /corporate/cards/invoices |
| Analityka | Podsumowanie i grupowania wydatków. | /corporate/cards/analytics |
Limity, posiadacze i centra kosztów
Limit według reguły.
Holder otrzymuje amount i interwał day, week lub month.
Wirtualna lub fizyczna.
Powiąż kartę z posiadaczem i w razie potrzeby określ limit, interwał i ograniczenie merchant.
Kontekst dla operacji.
Grupuj wydatki i sprawdzaj zakupy, kwoty i cashback według centrum kosztów.
Resources i paginacja
Odpowiedzi sukcesu identyfikują zasób przez resource. Listy używają ustandaryzowanej koperty z items, limit, total, offset, has_more i query_count.
{
"resource": "list",
"sort": "time-descending",
"items": [],
"limit": 100,
"total": 0,
"offset": 0,
"has_more": false,
"query_count": 0
}limit i offset są obsługiwane w listach. Domyślny limit to 100, a maksymalny 1000. W zgodnych zapytaniach ?refresh=true aktualizuje bazę IOPAY najnowszymi danymi z banku wydającego przed odpowiedzią.Wyciągi i analizy wydatków
Termin płatności i płatność.
Wyświetlaj wyciągi, ustaw dzień płatności między 1 a 28 i generuj dane płatności wyciągu, które mogą zawierać brcode i link.
Skonsolidowane wydatki.
Sprawdzaj łączne wydatki, liczbę zakupów, cashback i grupowania według kategorii, centrum kosztów, posiadacza i zmian miesięcznych.
Dane karty
Endpoint GET /corporate/cards/{card_id}/secrets zwraca PAN, CVV, datę ważności i TTL, gdy jest to potrzebne do operacji.
Kolekcja publiczna
Kolekcja zawiera 23 udokumentowane endpointy oraz przykłady sukcesu i błędów dla istotnych przepływów konta, doładowania, posiadaczy i operacji.