Banking & korttien myöntäminen

Kulujen hallinnan API

Integroi yritystili, saldo ja limiitti, kortinhaltijat, korttien myöntäminen, ostot, kustannuspaikat, laskut ja kuluanalyysit IOPAYn julkisen API:n kautta.

Base URLhttps://api.iopay.com.br/api/v1/baas
TunnistautuminenBearer token
LaajuusBanking · yrityskortit

Yritystilistä kulujen seurantaan.

API jäsentää yritystoiminnan erillisiksi resursseiksi ja pitää tilin, kortinhaltijat, kortit, ostot, laskut ja analyysit saman julkisen sopimuksen sisällä.

Banking

Tili, saldo ja limiitti.

Tarkista tilin tila ja saatavuus ja pyydä limiitin latauksia.

Korttien myöntäminen

Kortinhaltijat ja kortit.

Luo kortinhaltijoita, myönnä virtuaalisia tai fyysisiä kortteja ja sovella käyttösääntöjä.

Hallinta

Ostot, laskut ja analyysit.

Seuraa kuluja, kustannuspaikkoja, laskuja ja analyyttisiä ryhmittelyjä.

Yritystilin tila

Aktivointia ei tehdä julkisen API:n kautta. Päätepiste GET /corporate/cards/account on käytettävissä kaikissa tiloissa resurssin nykytilan tarkistamiseen.

01inactive

Aktivointia ei ole vielä pyydetty.

02waiting_contract_assignment

Päivitetty sopimus on hyväksyttävä IOPAY-tilillä.

03pending

Pyyntö IOPAY-tiimin arvioitavana.

04active

API-toiminnot käytettävissä.

Aktivointi. Julkista päätepistettä aktivoinnin pyytämiseen tai sopimuksen hyväksymiseen ei ole. Käyttöönotto tehdään IOPAY-tilillä. Tila suspended tarkoittaa, että resurssi ei ole tilin käytettävissä.

Perusvirta

01 · TiliTarkista tila.

Varmista, että resurssi on active.

02 · KortinhaltijaLuo holder.

Määritä identiteetti, limiitti, aikaväli ja kustannuspaikka.

03 · KorttiMyönnä kortti.

Valitse tyyppi, limiitti ja tarvittaessa liikerajoitus.

04 · ToimintaSeuraa kuluja.

Käytä ostoja, laskuja, kustannuspaikkoja ja analytiikkaa.

Luo kortinhaltija

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

Luo kortti

POST /corporate/cards
{
  "holder_id": "{{holder_id}}",
  "name": "Google Ads",
  "limit": 100000,
  "interval": "month",
  "type": "virtual",
  "merchant": "GOOGLE"
}
Merchant restriction. merchant määrittää liikerajoituksen, ei kortin nimeä. Käytä name-kenttää sisäisenä tunnisteena. Jos merchant jätetään pois tai lähetetään null, kenttä ei aseta rajoitusta.

Resurssit ja päätepisteet

AlueToiminnotPääreitti
TiliTila, saldo, limiitti ja lataus./corporate/cards/account · /balance · /recharge
KortinhaltijatListaa, hae, luo, päivitä ja peruuta./corporate/cards/holders
Kortit kortinhaltijoittainHae holderin kortit ja ostot./holders/{holder_id}/cards · /purchases
KortitListaa, hae, luo, päivitä ja hae arkaluonteiset tiedot./corporate/cards · /{card_id}/secrets
OstotYleislistaus sekä kortin/kortinhaltijan mukaan./corporate/cards/purchases
KustannuspaikatRyhmitellyt kulut ja kustannuspaikan tiedot./corporate/cards/cost-centers
LaskutListaa, muuta eräpäivää ja luo maksu./corporate/cards/invoices
AnalytiikkaKulujen yhteenveto ja ryhmittelyt./corporate/cards/analytics

Limiitit, kortinhaltijat ja kustannuspaikat

Kortinhaltija

Limiitti säännön mukaan.

Holder saa amount-arvon ja aikavälin day, week tai month.

Kortti

Virtuaalinen tai fyysinen.

Liitä kortti kortinhaltijaan ja määritä tarvittaessa limiitti, aikaväli ja liikerajoitus.

Kustannuspaikka

Kontekstia toimintaan.

Ryhmittele kulut ja tarkastele ostoja, summia ja cashbackia kustannuspaikoittain.

Resurssit ja sivutus

Onnistuneet vastaukset tunnistavat resurssin kentällä resource. Listaukset käyttävät vakioitua käärettä, jossa on items, limit, total, offset, has_more ja query_count.

Listauksen kääre
{
  "resource": "list",
  "sort": "time-descending",
  "items": [],
  "limit": 100,
  "total": 0,
  "offset": 0,
  "has_more": false,
  "query_count": 0
}
Sivutus. Listauksissa tuetaan limit- ja offset-parametreja. Oletusraja on 100 ja enimmäismäärä 1000. Yhteensopivissa kyselyissä ?refresh=true päivittää IOPAYn tietokannan myöntävän pankin uusimmilla tiedoilla ennen vastausta.

Laskut ja kuluanalyysit

Laskut

Eräpäivä ja maksu.

Listaa laskut, aseta eräpäivä väliltä 1–28 ja luo laskun maksutiedot, jotka voivat sisältää brcode- ja link-tiedot.

Analytiikka

Kootut kulut.

Tarkastele kokonaiskulutusta, ostojen määrää, cashbackia ja ryhmittelyjä kategorian, kustannuspaikan, kortinhaltijan ja kuukausikehityksen mukaan.

Kortin tiedot

Päätepiste GET /corporate/cards/{card_id}/secrets palauttaa PAN:n, CVV:n, voimassaolon ja TTL:n, kun toiminta sitä edellyttää.

Satunnainen käyttö. Vältä tämän päätepisteen vastauksen tallentamista tai kirjaamista. Collection itse ohjeistaa hakemaan nämä tiedot vain tarvittaessa.

Julkinen collection

Collection kokoaa 23 dokumentoitua päätepistettä sekä onnistumis- ja virhe-esimerkit tilin, latauksen, kortinhaltijoiden ja toiminnan keskeisiin virtoihin.