Developer platform

API on ydin.

Kokemus pysyy sinun.

Rakenna maksut suoraan tuotteeseesi. REST-API customereille, korteille, Pixille, boletolle ja luotolle, SDK:t, webhookit sekä omat referenssit tapahtumille, maksulinkeille, myyjille, maksujen jaolle ja kulujen hallinnalle.

REST APITuotantoSandboxWebhooksKortit jopa 21 erässäPixBoletoTokenisointi ja osto yhdellä klikkauksellaMaksulinkitMaksujen jako (Split)
IOPAY-dokumentaatio

Dokumentoidut ja järjestetyt API:t ja integraatioreferenssit

Laajenna maksutuotteita ja -palveluja palveluna. Aloita Base API:sta ja siirry toteutuksesi omaan referenssiin. Tapahtumat, maksulinkit, myyjät, maksujen jako, kyselyt, tokenisointi ja kulujen hallinta on järjestetty niin, että löydät nopeasti oikean referenssin.

docs-api.iopay.com.br
Julkinen dokumentaatio
Base API

Integraatiosi perusta.

Aloita tunnistautumisesta, ympäristön määrityksestä, customereista, korteista ja tokenisoinnista. Tapahtumakerros tulee seuraavassa vaiheessa.

FoundationBase API
AUTHBearer tokenPääsy
POST/api/v1/customer/newCustomer
POST/api/v1/card/tokenize/tokenTokenize
ENVsandbox / productionYmpäristöt
Tapahtuma-API

Luodusta maksusta tapahtuman koko elinkaareen.

Keskitä tänne Pixin, kortin ja boleton tapahtumatoiminnot: luonti, kysely, veloitus, peruutus, palautus ja tilan seuranta.

PaymentsTapahtuma-API
POST/api/v1/transaction/new/:CustomerIDLuo
GET/api/v1/transaction/get/:idHae
CAPtäysi tai osittainen veloitusVeloitus
VOIDperuutus / palautusElinkaari
Postman · Payment Links API V2

Muuta veloitus URL-osoitteeksi.

API V2 kokoaa linkkien luonnin, kyselyn, päivityksen, poiston ja listauksen sekä niiden synnyttämien tapahtumien kyselyn. Määritä tuotteet, maksutavat, erämaksut, korot, saatavuus, Order Bump, visuaalinen identiteetti ja Split, kun se on käytössä.

V2-määritysPayment Link
ITEMtitle + items[]Veloitus
PAYcredit / pix / boletoMaksutavat
TIMEopen_at / end_at / max_paymentsSaatavuus
CARDmax_installment + interestErämaksu
BUMPorder_bump_items[]Lisätarjous
BRANDprimary_color + bannersIdentiteetti
SPLITsplit_rules[]Jako
Postman · Sellers API

Osapuolet osana arkkitehtuuria.

Käytä omaa referenssiä alustan myyjiin liittyvien resurssien toteuttamiseen ja pidä tämä kerros erillään tapahtumaytimestä.

Postman Public collection
Sellers APIalustan osapuolet
Postman · Maksujen jako

Maksujen jako omalla referenssillään.

Käytä omaa collectionia maksujen jaon sääntöjen toteuttamiseen usean osapuolen toiminnoissa ja pidä kerros erillään Base API:sta ja tapahtuma-API:sta.

Postman Public collection
Maksujen jako (Split)maksujen jaon säännöt
Kulujen hallinta & yrityskortit

Alustaan yhdistetty yrityskontrolli.

Oma osio yrityskorttien myöntämiseen ja hallintaan, limiittien, käyttökäytäntöjen ja kortinhaltijoiden määrittämiseen sekä kulutoiminnan seurantaan.

CorporateYrityskortit
CARDmyöntäminen ja hallinta yrityksittäinKortit
RULElimiitit ja käyttökäytännötKontrolli
TEAMkortinhaltijat ja kustannuspaikatTiimi
VIEWkoottu näkymä kuluistaToiminta
Quickstart

Ensimmäisestä requestista
ensimmäiseen veloitukseen.Kolmessa vaiheessa.

Määritä tunnistautuminen, luo customer ja luo Pix-veloitus samalla virralla, jonka sovelluksesi vie tuotantoon.

Vaihe01/ 03 ·Tunnistaudu requesteihin
Vaihe 01 · Pääsy

Tunnistaudu requesteihin

Jokainen integraatio alkaa tunnisteidesi todentamisella API:n käyttötunnuksen saamiseksi.

Bearer TokenTransaction3600s
Mitä tässä vaiheessa tehdään
  • Lähetä email, secret ja io_seller_id.
  • Vastaanota access_token.
  • Käytä Bearer Tokenia seuraavissa requesteissa.
Ymmärrä tämä vaihe
Tavoite
Sovelluksesi alkaa kommunikoida IOPAY API:n kanssa todennetusti.
Odotettu vastaus
Käyttötunnus seuraavien requestien todentamiseen.
Missä kohtaa
Integraation alussa, ennen customereiden, korttien tai tapahtumien käyttöä.
Tunnistautumisesimerkki
Docs ↗

        
Esimerkkivastaus · JSON
Seuraava vaihe

Kun tunnistautuminen on valmis, seuraava vaihe on luoda ostaja, jolle veloitus kohdistuu.





Maksutavat

Yksi integraatio.Jokaisella maksulla
oma polkunsa.

Pix, kortti ja boleto elävät tapahtumaytimessä. Maksulinkit vievät saman infrastruktuurin avustettuun myyntiin, etäveloituksiin ja kanaviin, joilla ei ole omaa checkoutia.

PIX

Pix

Pikaveloitusten luonti, QR-koodi ja vahvistuksen seuranta tapahtumien avulla.

Sopii checkoutiin, etäveloituksiin ja välittömiin maksuvirtoihin.
CC

Kortit

Kertamaksu- tai erämaksuluotto, tokenisointi sekä uusintaosto- ja toistuvaismaksupolut.

Mahdollistaa oman checkoutin yhdistämisen toiminnan valtuutusvirtoihin.
BLT

Boleto

Veloitusten luonti ja seuranta poluille, jotka edellyttävät maksua tositteella.

Veloituksen tila voidaan integroida yrityksen sisäisiin prosesseihin.
LNK

Maksulinkit

Luo isännöityjä ja jaettavia veloituksia API:n kautta myydäksesi perinteisen checkoutin ulkopuolella.

CRM, WhatsApp, inside sales, asiakaspalvelu ja avustetut polut.


Webhookit ja tapahtumat

Järjestelmäsi ei tarvitse kysyä.
Iopay ilmoittaa sekunneissa.

HTTP POST Reaaliaika Ei pollausta

IOPAY vastaanottaa maksun päivityksen, käsittelee uuden tilan ja lähettää webhookin päätepisteeseesi. Vähän kitkaa, selkeä virta ja synkronoidut järjestelmät.

Luota Iopayn vikasietoiseen webhook- ja tapahtumakerrokseen, jossa on automaattinen uudelleentoimitus, jos palvelimesi ei ole tavoitettavissa.

01 · Lähde Maksu muuttuu.

Uusi tila infrastruktuurissa.

→→→→→→→→→→→→→→
03 · Järjestelmäsi Webhook saapuu. Aina.

Päätepisteesi vastaanottaa Iopayn POST-requestin, ja sinä käsittelet ja reagoit haluamallasi tavalla. Järjestelmäsi toimii, kun maksu on luotu, hyväksytty, epäonnistunut, palautettu tai osittain peruttu. Vahvistuksen myötä järjestelmälläsi on kaikki tarvittava tilauksen vapauttamiseen, CRM:n ja ERP:ien päivittämiseen, SAP-yhteistoimintaan sekä fulfillmentin ja laskutuksen integrointiin.

SDKs IOPAY

SDK:t Javalle, Javascriptille, Node.js:lle ja
PHP:lle / Laravelille.

Käytä IOPAYn julkisia clienttejä Node.js:ssä ja PHP:ssä / Laravelissa tai integroi suoraan REST-API:n kautta millä tahansa kielellä. Vähemmän boilerplatea alkuun ilman, että menetät pääsyn alustan HTTP-sopimukseen.

Virallinen SDK · Node.js

Valmis integraatio JavaScript-sovelluksille.

Julkinen client tunnistautumisella, ympäristöillä, tokenisoinnilla, customereilla ja tärkeimmillä tapahtumatoiminnoilla.

Asennus
npm install
@iopay-payments/iopay-api-sdk-nodejs

// depois, use o client IOPAY no projeto
Virallinen SDK · PHP

Composer PHP- tai Laravel-projekteihin.

Virallisen paketin iopay-payments/sdk-php voi asentaa Composerilla ja käyttää projektin autoloadin kautta, myös Laravel-sovelluksissa.

Asennus Composerilla
composer require
iopay-payments/sdk-php

// disponível no vendor/autoload.php do projeto
REST API · mikä tahansa stack

Käytä suoraa HTTP:tä, kun haluat täyden hallinnan.

Python, Go, Java, .NET, Ruby tai mikä tahansa muu stack voi käyttää IOPAY API:a suoraan HTTPS:n kautta samoilla julkaistuilla päätepisteillä ja sopimuksilla.

Yleinen esimerkki
curl --request GET \\
  --url https://api.iopay.com.br/api/v1/customer/get/:CustomerID \\
  --header 'Authorization: Bearer your_token' \\
  --header 'Content-Type: application/json'
Toiminta

Integraation ja toiminnan on puhuttava samaa kieltä.

Käyttöönoton jälkeen kehityksen, tuotteen, taloushallinnon ja asiakaspalvelun on nähtävä sama maksu. IOPAY-portaali täydentää API:a tapahtumanäkymällä, saamisilla, tunnisteilla, raporteilla ja toiminnan seurannalla.

01Tapahtumat Tarkista tila, asiakas, maksutapa, summa ja toiminnan viitteet.
02Saamiset Seuraa käsiteltyyn myyntiin liittyvää taloudellista näkymää.
03Tunnisteet Keskitä integraatioympäristöissä tarvittavat tiedot.
04Raportit Tue toiminnan ja täsmäytyksen rutiineja ilman riippuvuutta pelkästään kehitystiimistä.
IOPAY-toimintaKoottu näkymä
TAPAHTUMAT883
HYVÄKSYNTÄ60,4%
TPVR$ 2,58 milj.
TapahtumaMaksutapaTilaSumma
0b527...9a6creditHyväksyttyR$ 1 002
44d23...9044pixOdottaaR$ 3 482
34fad...29e7creditHyväksyttyR$ 5 444
Turvallisuus & arkkitehtuuri ytimenä ja perusperiaatteena

API:t ja arkkitehtuuri, jotka on suunniteltu pyörittämään
maksuja hallitusti, turvallisesti ja näkyvästi.

Tunnisteet, ympäristöjen eriyttäminen, tokenisointi ja turvakontrollit ovat osa tuotearkkitehtuuria ja vähentävät arkaluonteisten tietojen tarpeetonta altistumista.

01Eriytetyt tunnisteet

Erottele kehitys, testaus ja tuotanto kullekin ympäristölle sopivilla tunnisteilla.

02Tokenisointi

Vähennä arkaluonteisten tietojen liikkumista uusintaosto-, toistuvaismaksu- ja one-click-poluilla.

03PCI DSS 4.0.1

Turvakontrollit ja maksuympäristön suojaus IOPAY-infrastruktuurissa.

04Tapahtumat ja jäljitettävyys

Käytä tunnisteita, tiloja ja webhookeja tapahtuman elinkaaren seuraamiseen ja poikkeuksiin reagoimiseen.

Käyttötapaukset

Arkkitehtuuri erilaisille
liiketoimintamalleille.

IOPAY Developer Platform on suunniteltu tuotteille, joiden on upotettava maksut omaan kokemukseensa, verkkokaupasta SaaSiin, markkinapaikkoihin, ERP:hen ja avustettuun myyntiin.

Verkkokauppa

Oma checkout.

Hallitse ostajan kokemusta, kun IOPAY ajaa maksu- ja tapahtumakerrosta.

Katso verkkokauppa →
SaaS & toistuvaismaksut

Uusintaosto ja jatkuva laskutus.

Yhdistä tokenisointi, customerit, tapahtumat ja sovelluksesi logiikka toistuviin polkuihin.

Katso dokumentaatio →
Markkinapaikat

Myyjät ja maksujen jako.

Tuo myyjien konteksti ja maksujen jaon säännöt tapahtumavirtaan.

Katso markkinapaikat →
ERP & talous

Toimintaan yhdistetyt maksut.

Integroi veloitukset ja tapahtumat sisäisiin täsmäytys-, asiakaspalvelu- ja talousprosesseihin.

Puhu asiantuntijan kanssa →
Inside sales

Veloitus myyntisuppilossa.

Luo linkkejä tai tapahtumia CRM:stä ja palauta tila myynnille, onboardingille ja taloushallinnolle.

Katso linkit →
White-label

Infrastruktuuri kokemuksesi alla.

Yhdistä API:t ja alustaresurssit tarjotaksesi brändiisi integroituja maksupolkuja.

Katso white-label →
IO-integraatio ja API:t

Ensimmäisestä kutsusta tuotantoon. Luota parhaaseen maksuratkaisujen arkkitehtuuriin

Tutustu dokumentaatioon, testaa integraatiosi ja tuo maksut tuotteeseesi IOPAY-infrastruktuurilla.