Panking & card issuance

Kulude haldamise API

Täiendage ettevõtte konto, saldo ja piir, kandjad, kaardiandmine, ostud, kuluasutused, arved ja kulude analüüsid avalikel API IOPAY.

Base URLhttps://api.iopay.com.br/api/v1/baas
AuthentificationBearer token
KohtumineBanking · corporate cards

Ettevõtte kontost kulude jälgimiseks.

API korraldab ettevõtte toimingut eraldi vahendites, hoides kontot, kandjaid, kaarte, ostusid, arve ja analüüse samasse avaliku sektori lepingusse.

Banking

Arve, tasakaal ja piir.

Kontrollige konto staatust, kättesaadavust ja nõua piirmääratasu.

Kaardide väljastamine

Kaardid ja kandjad.

Looda oma kandjad, anna välja füüsilised või virtuaalsed kaardid ja rakenda kasutuse reegleid.

Haldamine

Ostu, arve ja analüüs.

Jälgi kulutusi, kulukeskusi, arveid ja analüütilisi rühmitusi.

Ühingu konto staatus

Aktiveerimine ei toimu avalikust API. Kõrgpunkt GET /corporate/cards/account on igal riigis kättesaadav kaebuse praeguse seisundi vaatamiseks.

01inactive

Täiendav aktiveerimine pole veel taotlenud.

02waiting_contract_assignment

Päevased lepingud peavad olema aktsepteeritud IOPAY kontoga.

03pending

IOPAY'i meeskonna analüüsitud taotlus.

04active

Avalikud API toimingud.

Ativação. Ei ole avalikku lõpppunkti, kus taotleda aktiveerimist või lepingut võtta. Kasutamine toimub konto IOPAY kaudu. Statuus suspended märgib, et kontole ei ole vahend.

Baasivoog

01 · kontoVaadake seisundit.

Kohta, et vahend on olemas active.

02 · PortsLoe hooldja.

Määrake identiteet, piir, interval ja kulu keskus.

03 · KaardAndke kaart välja.

Valige tüüp, piir ja asutamispiirang, kui see on asjakohane.

04 · OperatsioonSee on kulutuste jälgimine.

Kasuta ostusid, arveid, kulutuskeskusid ja analüüse.

Lase luua kandja

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

Kardi loomine

POST /corporate/cards
{
  "holder_id": "{{holder_id}}",
  "name": "Google Ads",
  "limit": 100000,
  "interval": "month",
  "type": "virtual",
  "merchant": "GOOGLE"
}
Kaubanduspiirangu. merchant määratleb asutamispiirangut, mitte kaardi nime. Kasuta name kui sisemist tuvastamist. Lõpeta merchant või saata null ei määra piiranguid selle valdkonna jaoks.

Ressursse ja lõpppunktidega

AreaOperatsioonidPeamine tee
LuudaStatus, tasakaal, piir ja laad./corporate/cards/account · /balance · /recharge
KaardiomanikudLoata, vaata, luua, ajakohastada ja tühistada./corporate/cards/holders
Kardid kandja kohtaKontrollida kaarte ja ostusid omanikult./holders/{holder_id}/cards · /purchases
KaardidLoetellu, vaadelda, luua, ajakohastada ja vaadelda tundlikke andmeid./corporate/cards · /{card_id}/secrets
OstudÜldnimekiri ja kaardi- ja kandjaarvestus./corporate/cards/purchases
Kulu keskusedKokkuvõetud kulud ja keskuse üksikasjad./corporate/cards/cost-centers
ArvedLoetleda, vahetada tähtaega ja maksma./corporate/cards/invoices
AnalyticsKokkuvõte ja kulude kokkuvõte./corporate/cards/analytics

Limited, kandjad ja kuluasutused

Kaardiomanik

Piirangud reeglite järgi.

Oleja saab amount ja vahepeal day, week või month.

Kaart

Virtuaalne või füüsiline.

Seadke kaardi kandjale ja seadke vajadusel kaupleja piir, interval ja piir.

Kulu keskus

Operatsiooni kontekst.

Räägi kulusid kokku ja vaata ostusid, väärtusi ja kassa tagasi kulude keskuse järgi.

Ressursse ja pagumine

Tõhusad vastused tunnistavad vahendit resource. Listingud kasutavad standardiseeritud ümbriku items, limit, total, offset, has_more ja query_count.

Listing envelop
{
  "resource": "list",
  "sort": "time-descending",
  "items": [],
  "limit": 100,
  "total": 0,
  "offset": 0,
  "has_more": false,
  "query_count": 0
}
Paginação. limit ja offset need on loetelus kinnitatud. Standard on 100 ja maksimaalne on 1000. Kohustatavad konsultatsioonid ?refresh=true ajakohastage IOPAY baasi enne vastust lähimate andmetega emiteeriva pangast.

Kulutuste aruanne ja analüüs

Arved

Võit ja makse.

Loe välja arved, seadige tähtaeg 1 kuni 28 ja loota makseandmed, mis võivad sisaldada: brcode ja link.

Analytics

Kokkuvõetud kulutused.

Vaata kogu kulutust, ostude kogust, kassa tagasi ja kategooria, kulu keskuse, kandja ja kuu arengut.

Kaardi andmed

Kõrgpunkt GET /corporate/cards/{card_id}/secrets tagastab PAN, CVV, kehtivus ja TTL, kui see on vajalik operatsiooni jaoks.

Päriselt kasutamiseks. Ärge ladustage või salvestage selle lõpppunkti vastust. Kokkuvõtt ise soovitab neid andmeid küsida ainult kui see on vajalik.

Ühiskollektsioon

Kolektsioon toob kokku 23 dokumenteeritud lõpppunkti, näiteid edukast ja eksitusest, mis on seotud kontori, laadimise, kandjate ja toimimisega.