Kehittäjäalusta

API on ydin.
Kokemus on edelleen omasi.

Rakenna maksuja suoraan tuotteeseesi. API REST asiakkaille, korteille, Pix, boleto ja luotto SDKs, webhooks sekä erityiset viittaukset Transactional, Maksulinkit, Sellers, Maksujen Jakaminen ja Kulujen Hallinta.

REST APISandboxNode.jsPHP / LaravelWebhooksMaksulinkitMaksujen Jakaminen
POST /api/v1/transaction/new/:CustomerID
uusi luottokorttitapahtuma
application/json
{
  "amount": 14990,
  "currency": "BRL",
  "description": "Pedido #102938",
  "id_card": "23082eb67cd54e7eb4c9cf8c760bd12f",
  "capture": 1,
  "statement_descriptor": "IOPAY STORE",
  "installment_plan": {
    "number_installments": 1
  },
  "io_seller_id": "<IO_SELLER_ID>",
  "payment_type": "credit",
  "reference_id": "102938"
}
application/json Transaktioon reagointi
{
  "success": {
    "id": "7f38b2c94e1a4d69a81f53b76d9c204e",
    "resource": "transaction",
    "status": "succeeded",
    "payment_type": "credit",
    "amount": "149.90",
    "captured": true,
    "currency": "BRL",
    "reference_id": "102938",
    "payment_method": {
      "resource": "card",
      "card_brand": "Visa",
      "last4_digits": "4242"
    },
    "installment_plan": {
      "mode": "interest_free",
      "number_installments": "1"
    },
    "created_at": "2026-10-06T20:09:48+00:00"
  }
}
Kortti, jossa ei ole uutta tietoa.Käytä id_card:ta jo customer:n yhteydessä ja luo tapahtuma.
IOPAY-dokumentaatio

APIs ja Dokumentoidut ja järjestäytyneet kotoutumissuositukset

Laajenna maksutuotteita ja -palveluja palveluna. Aloita API-tukikohdasta ja siirry sen toteuttamiseen liittyvään erityisviittaukseen. Transaktio, Maksulinkit, Sellers, Maksujen Jakaminen, Konsultaatiot, Tokenization ja Kulujen Hallinta ovat järjestäytyneitä, ja pääset nopeasti oikeaan viitekohtaan.

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

Heidän integraationsa perusta.

Se alkaa varmennuksesta, ympäristön, asiakkaiden, korttien ja leimaamisen perustamisesta. Transaktiokerros siirtyy seuraavaan vaiheeseen.

SäätiöPerus-API
AUTHBearer tokenKäyttöoikeus
POSTv1/customer/newAsiakas
POSTv1/card/tokenize/tokenTokenize
ENVsandbox / productionYmpäristöt
Tapahtuma-API

Luodusta maksusta koko tapahtumasykliin.

Keskity tähän Pix:n, kortin ja boleto:n liiketoimiin: luominen, konsultointi, kaappaus, peruutus, palautus ja statuksen seuranta.

MaksusitoumuksetTapahtuma-API
POSTv1/transaction/new/:CustomerIDLuo
GETv1/transaction/get/:idTarkastele
CAPcaptura total ou parcialKaappaus
VOIDcancelamento / estornoSykli
Postman · Maksulinkit API V2

Käännä lataus URL-osoitteeksi.

API V2 sisältää linkin luomisen, kyselyn, päivityksen, poiston ja listauksen sekä kyselyn syntyneistä liiketoimista. Aseta kohteita, maksuvälineitä, maksueriä, korkoja, käytettävyyttä, tilausbumpia, visuaalista identiteettiä ja Splitiä, kun se on käytössä.

V2-kokoonpanoMaksulinkki
ITEMtitle + items[]Maksupyyntö
PAYcredit / pix / boletoMenetelmät
TIMEopen_at / end_at / max_paymentsKäytettävyys
CARDmax_installment + interestOsamaksut
BUMPorder_bump_items[]Lisätarjous
BRANDprimary_color + bannersIdentiteetti
SPLITsplit_rules[]Jakautuminen
Postman · Sellers API

Osallistujia käsiteltiin osana arkkitehtuuria.

Ks. erityinen viite Sellers-alustan ominaisuuksien käyttöönotolle ja tämän kerroksen pitämiselle erillään tapahtumaytimestä.

Postman Julkinen kokoelma
Sellers APIFoorumin osallistujat
Postman · Maksujen Jakaminen

Maksujen Jakaminen omalla tiedolla.

Käytä omistettua kokoelmaa Maksujen Jakaminen-sääntöjen täytäntöönpanoon monitoimitoiminnassa ja pidä tämä kerros erillään API-perustasosta ja Tapahtuma-API-tasosta.

Postman Julkinen kokoelma
Maksujen JakaminenMaksujen Jakaminen:n säännöt
Kulujen Hallinta ja Yrityskortit

Alustaan liitetty yhtiön määräysvalta.

yrityskortit:n liikkeellelaskulle ja hallinnalle omistettu rintama, jossa asetetaan rajat, käyttötavat, liikenteenharjoittajat ja menojen seuranta.

YritysYrityskortit
CARDemissão e gestão por empresaKortit
RULElimites e políticas de usoHallinta
TEAMportadores e centros de custoTiimi
VIEWvisão consolidada de gastosToiminta
Pikakäynnistys

Ensimmäisestä pyynnöstä
ensimmäinen lataus.
Kolmessa vaiheessa.

Aseta varmennus, luo customer ja hallinnoi Pix-latausta samalla virtauksella, jonka sovellus vie tuotantoon.

Ensimmäinen kotoutuminen

Oikotie API:n rakenteen ymmärtämiseen ennen muiden ominaisuuksien tutkimista.

Avaa viite API –
01
Aktiivinen vaihePyyntöjen tunnistaminen
Vaihe 01 · Pääsy

Pyyntöjen tunnistaminen

Jokainen integraatio alkaa oikeassa ympäristössä ja on oikea merkki auktoriteettiotsikossa.

Bearer tokenSandboxTuotanto
Tavoite

Hakemuksesi on nyt vahvistettu oikeaksi API IOPAY -sovellukseen.

Odotettu tuotto

Täältä voit kutsua seuraavia integraation reittejä.

Minne se menee?

Kotouttamisen alussa, ennen asiakkaiden tai liiketoimien luomista.

Tarkastuslista
  • Valitse hiekkalaatikko tai tuotanto.
  • Lisää valtuutus: Bearer seu_token.
  • Lähetä Content-Type: Application/json.
Esimerkki varmennuksesta
curl --request GET \
  --url https://api.iopay.com.br/api/v1/customer/get/:customerId \
  --header 'Authorization: Bearer seu_token' \
  --header 'Content-Type: application/json'
Seuraava vaihe

Kun tunnistautuminen on valmis, seuraava askel on luoda ostaja, joka saa maksun.

Authorization: Bearer seu_token





Maksutavat

Se on yhdentyminen.Jokainen maksu,
Oma matkasi.

Pix, kortti ja boleto elävät siirtoytimessä. Maksulinkeissä on sama infrastruktuuri avustettuun myyntiin, etälataukseen ja kanaviin ilman omaa kassaa.

PIX

Pix

Luo pikalaskuja, QR Code ja seuraa vahvistusta tapahtumakohtaisesti.

Ihanteellinen kassalle, etälaskutukseen ja pikamaksuvirtoihin.
CC

Kortit

Kertamaksu luottokortilla- tai paketointi-, sulautus- ja takaisinosto- tai uusintamatkat.

Sen avulla voit yhdistää oman kassan ja toiminnan lupavirrat.
BLT

Boleto

Omistuksen maksamista edellyttävien matkojen maksujen liikkeeseenlasku ja seuranta.

Vastaanottoilmoitus voidaan liittää yhtiön sisäisiin prosesseihin.
LNK

Maksulinkit

Luo API:lle jaettuja, isännöityjä maksuja myytäväksi perinteisen kassan ulkopuolella.

CRM, WhatsApp, sisällä myynti, palvelu ja osallistui matkustamiseen.


Webhooks & tapahtumat

Järjestelmäsi ei tarvitse kysyä.
Iopay hälytetään sekunnissa.

HTTP POST Reaaliaika Ei kannatuskyselyjä

IOPAY vastaanottaa maksupäivityksen, käsittelee uuden tilan ja lähettää webhook:n päätetapahtumaansa. Matala kitka, selkeä virta ja synkronoidut järjestelmät.

Luota webhooks-kerrokseen ja sietämättömiin Iopay-tapahtumiin automaattisella uudelleenjakelulla tapauksissa, joissa palvelin ei ole käytettävissä.

01 · Alkuperä Palkka on muuttumassa.

Infrastruktuurin uusi tila.

→→→→→→→→→→→→→→
03 · Sen järjestelmä webhook on täällä. Ainahan minä.

Päätetapahtumasi saa postituspyynnön Iopay:lta, ja käsittelet ja reagoit miten haluat. Järjestelmäsi ryhtyy toimiin sen jälkeen, kun maksu on luotu, hyväksytty, epäonnistunut, peruutettu tai osittain peruutettu. Takavarikoinnin avulla järjestelmäsi voi julkaista pyynnön, syöttää CRM & ERP:t, olla vuorovaikutuksessa SAP:n kanssa, integroida kokotekstin ja veroilmoituksen.

SDKs IOPAY

SDKs Javalle, JavaScriptille, Node.jsille ja
PHP / Laravel.

Käytä julkisia IOPAY-asiakkaita solmukohdissa ja PHP / Laravel:ssa tai integroi suoraan API REST:n kautta millä tahansa kielellä. Aluksi vähemmän kattilalevyä, ilman, että HTTP-alustasopimuksen käyttö menetetään.

Virallinen SDK · Node.js

Valmiina integroitumaan JavaScript-sovelluksiin.

Julkinen asiakas, jolla on aitous, ympäristöt, sulautus, asiakkaat ja merkittävät liiketoiminnat.

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

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

PHP- tai Laravel-projektien säveltäjä.

Virallinen paketti iopay-payments/sdk-php Se voidaan asentaa Composer-sovelluksen kautta ja käyttää projektin automaattiseen kuormaukseen, myös Laravel-sovelluksissa.

Säveltäjän asentaminen
composer require
iopay-payments/sdk-php

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

Käytä HTTP:tä suoraan aina, kun haluat täydellistä hallintaa.

Python, Go, Java, .NET, Ruby tai mikä tahansa muu pino voi kuluttaa API IOPAY:n suoraan HTTPS:n kautta käyttäen samoja julkaistuja päätetapahtumia ja sopimuksia.

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

Kotouttamisen ja toiminnan pitää puhua samaa kieltä.

Käyttöönoton jälkeen insinöörien, tuotteiden, rahoituksen ja palvelun on nähtävä sama hyöty. IOPAY-portaali täydentää API-verkkoa transaktionäkemyksellä, saamisilla, valtakirjoilla, raporteilla ja operatiivisella seurannalla.

01Tapahtumat Tutustu liiketoimen tilaan, asiakkaaseen, menetelmään, arvoon ja viitetietoihin.
02Saatavat Pidä kirjaa jalostetun myynnin taloudellisista näkymistä.
03Tunnistetiedot Keskitetään kotoutumisympäristöissä tarvittavat tiedot.
04Raportit Tue rutiinitoimintoja ja sovintoa luottamatta pelkästään insinööritiimiin.
Operaatiot IOPAYKonsolidoitu näkö
TAPAHTUMAT883
HYVÄKSYNTÄ60,4%
TPVR$ 2,58M
TapahtumaMenetelmäEuroopan parlamentinSumma
0b527...9a6creditHyväksyttyR$ 1.002
44d23...9044pixMuutR$ 3.482
34fad...29e7creditHyväksyttyR$ 5.444
Turvallisuus ja arkkitehtuuri ydin- ja perusperiaatteena

APIs ja toimintaan suunniteltu arkkitehtuuri
maksut, joissa on valvontaa, turvallisuutta ja näkemystä.

Valtakirjat, ympäristön eriytyminen, sulauttaminen ja turvavalvonta ovat osa tuotearkkitehtuuria ja vähentävät tarpeetonta altistumista arkaluonteiselle datalle.

01Erilliset valtakirjat

Erillinen kehittäminen, testaus ja tuotanto, jossa on kuhunkin ympäristöön sopivat tiedot.

02Tokenisointi

Vähentää arkaluonteisten tietojen kulkua takaisinostoissa, noutokäynneissä ja yhdellä klikkauksella.

03PCI DSS 4.0.1

IOPAY-infrastruktuuriin sovelletaan maksuturvaa ja ympäristönsuojelua.

04Tapahtumat ja jäljitettävyys

Käytä tunnisteita, statusta ja webhooks:ta seurataksesi tapahtumasykliä ja vastataksesi poikkeuksiin.

Käyttökotelot

Arkkitehtuuri erilaisille
liiketoimintamallit.

Developer Platform IOPAY on suunniteltu tuotteisiin, joiden on sisällytettävä maksut itse verkkokauppakokemukseen SaaS:lle, markkinoille, ERP:lle ja avustettuun myyntiin.

SaaS & toistuminen

Lataus ja jatkuva lataus.

Siinä yhdistyvät toistuvan matkan tokenisointi, asiakkaat, tapahtumat ja logiikka.

Katso myös asiakirjat →
Marketplaces

Sellers ja Maksujen Jakaminen.

Ota huomioon Sellers:n konteksti ja Maksujen Jakaminen:n säännöt tapahtumavirran suhteen.

Katso markkinapaikat →
ERP ja rahoitus

Toimenpiteeseen liittyvät maksut.

Integroi laskut ja tapahtumat sisäisiin selvitys-, palvelu- ja rahoitusprosesseihin.

Asiantuntijalle puhuminen →
Sisäinen myynti

Lataudu suppilon sisään.

Hallitse CRM:n linkkejä tai liiketoimia sekä myynnin, veneilyn ja rahoituksen palautustilaa.

Katso myös linkit →
White-label

Kokemuksesi mukaan infrastruktuuri.

Yhdistä APIs- ja alustaominaisuudet ja tarjoa maksullisia matkoja, jotka on integroitu brändiisi.

Katso valkoinen pakkaus →
Integrointi ja APIs IO

Ensimmäisestä puhelusta tuotantoon. Paras maksuratkaisuarkkitehtuurin varaan

Tutustu dokumentointiin, testaa sen integrointia ja helpota IOPAY-infrastruktuurin maksua tuotteeseesi.