Banking & kaartide väljastamine

Kulude halduse API

Lõimi ettevõtte konto, saldo ja limiit, kaardiomanikud, kaartide väljastamine, ostud, kulukeskused, arved ja kuluanalüüsid IOPAY avaliku API kaudu.

Base URLhttps://api.iopay.com.br/api/v1/baas
AutentimineBearer token
UlatusBanking · ärikaardid

Ettevõtte kontost kulude jälgimiseni.

API korraldab ettevõtte toimingud eraldi ressurssideks, hoides konto, kaardiomanikud, kaardid, ostud, arved ja analüüsid sama avaliku lepingu sees.

Banking

Konto, saldo ja limiit.

Vaata konto staatust ja kättesaadavust ning taotle limiidi laadimist.

Kaartide väljastamine

Kaardiomanikud ja kaardid.

Loo kaardiomanikke, väljasta virtuaalseid või füüsilisi kaarte ja rakenda kasutusreegleid.

Haldus

Ostud, arved ja analüüsid.

Jälgi kulusid, kulukeskusi, arveid ja analüütilisi grupeeringuid.

Ettevõtte konto staatus

Aktiveerimist ei tehta avaliku API kaudu. Lõpp-punkt GET /corporate/cards/account jääb igas olekus kättesaadavaks, et vaadata ressursi praegust olukorda.

01inactive

Aktiveerimist pole veel taotletud.

02waiting_contract_assignment

Uuendatud leping tuleb IOPAY kontol aktsepteerida.

03pending

Taotlus IOPAY meeskonna analüüsis.

04active

API toimingud saadaval.

Aktiveerimine. Aktiveerimise taotlemiseks või lepingu aktsepteerimiseks pole avalikku lõpp-punkti. Lubamine toimub IOPAY kontol. Staatus suspended näitab, et ressurss pole kontole kättesaadav.

Põhivoog

01 · KontoVaata staatust.

Veendu, et ressurss on active.

02 · KaardiomanikLoo holder.

Määra identiteet, limiit, intervall ja kulukeskus.

03 · KaartVäljasta kaart.

Vali tüüp, limiit ja vajaduse korral kaupmehe piirang.

04 · ToimingudJälgi kulusid.

Kasuta oste, arveid, kulukeskusi ja analüütikat.

Loo kaardiomanik

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

Loo kaart

POST /corporate/cards
{
  "holder_id": "{{holder_id}}",
  "name": "Google Ads",
  "limit": 100000,
  "interval": "month",
  "type": "virtual",
  "merchant": "GOOGLE"
}
Merchant restriction. merchant määrab kaupmehe piirangu, mitte kaardi nime. Kasuta name sisemise tuvastusena. merchant ära jätmine või null saatmine ei määra selle välja kaudu piirangut.

Ressursid ja lõpp-punktid

ValdkondToimingudPõhimarsruut
KontoStaatus, saldo, limiit ja laadimine./corporate/cards/account · /balance · /recharge
KaardiomanikudLoetle, päri, loo, uuenda ja tühista./corporate/cards/holders
Kaardid kaardiomaniku kaupaPäri holderi kaardid ja ostud./holders/{holder_id}/cards · /purchases
KaardidLoetle, päri, loo, uuenda ja päri tundlikud andmed./corporate/cards · /{card_id}/secrets
OstudÜldloend ning kaardi/kaardiomaniku kaupa./corporate/cards/purchases
KulukeskusedGrupeeritud kulud ja kulukeskuse üksikasjad./corporate/cards/cost-centers
ArvedLoetle, muuda tähtaega ja loo makse./corporate/cards/invoices
AnalüütikaKulude kokkuvõte ja grupeeringud./corporate/cards/analytics

Limiidid, kaardiomanikud ja kulukeskused

Kaardiomanik

Limiit reegli järgi.

Holder saab amount ja intervalli day, week või month.

Kaart

Virtuaalne või füüsiline.

Seo kaart kaardiomanikuga ning määra vajaduse korral limiit, intervall ja kaupmehe piirang.

Kulukeskus

Kontekst toimingule.

Grupeeri kulud ning vaata oste, summasid ja cashbacki kulukeskuse kaupa.

Ressursid ja lehekülgedeks jagamine

Edukad vastused tuvastavad ressursi välja resource kaudu. Loendid kasutavad standardset ümbrist väljadega items, limit, total, offset, has_more ja query_count.

Loendi ümbris
{
  "resource": "list",
  "sort": "time-descending",
  "items": [],
  "limit": 100,
  "total": 0,
  "offset": 0,
  "has_more": false,
  "query_count": 0
}
Lehekülgedeks jagamine. Loendites toetatakse limit ja offset. Vaikimisi limiit on 100 ja maksimum 1000. Ühilduvates päringutes uuendab ?refresh=true enne vastust IOPAY andmebaasi väljastava panga uusimate andmetega.

Arved ja kuluanalüüsid

Arved

Tähtaeg ja makse.

Loetle arved, määra tähtpäev vahemikus 1 kuni 28 ja loo arve makseandmed, mis võivad sisaldada brcode ja link välju.

Analüütika

Koondatud kulud.

Vaata kogukulu, ostude arvu, cashbacki ja grupeeringuid kategooria, kulukeskuse, kaardiomaniku ja kuise arengu järgi.

Kaardi andmed

Lõpp-punkt GET /corporate/cards/{card_id}/secrets tagastab PAN-i, CVV, kehtivusaja ja TTL-i, kui see on toiminguks vajalik.

Ühekordne kasutus. Väldi selle lõpp-punkti vastuse salvestamist või logimist. Kollektsioon ise soovitab neid andmeid pärida ainult vajadusel.

Avalik kollektsioon

Kollektsioon koondab 23 dokumenteeritud lõpp-punkti ning õnnestumise ja vea näited konto, laadimise, kaardiomanike ja toimingute oluliste voogude jaoks.