Developer platform

API on tuum.
Kogemus jääb sinu omaks.

Kasutage maksed otse oma toodetesse. Kliendile API REST kaardid, Pix, boleto ja krediidi koos SDKs, webhooks ja pühendatud viited Transaktssioon, Makselingid, Sellers, Maksete Jaotamine ja Kulude Haldamine.

REST APISandboxNode.jsPHP / LaravelWebhooksMakselingidMaksete Jaotamine
POST /api/v1/transaction/new/:CustomerID
Uus krediitkaardiga tehing
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 Transaction response
{
  "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"
  }
}
Kaard, mis ei võta andmeid tagasi.Kasuta seda id_card algu seotud customer ja luua tehing.
IOPAY dokumentatsioon

APIs ja dokumenteeritud ja organiseeritud integreerimisreferendid

Laiendage tasumistooteid ja teenuseid teenusena. Alustage API Baasiga ja minege selle rakendamise konkreetsele referentsile. Transactional, Makselingid, Sellers, Maksete Jaotamine, Küsimused, Tokeniseerimine ja Kulude Haldamine on korraldatud.

docs-api.iopay.com.br
Avalik dokumentatsioon
Põhi-API

Nende integreerimise aluseks.

Alustame autentimise, keskkonna seadistamisega, klientidega, kaardidega ja tokendamisega. Transaktsiaalne katus läheb järgmisele etapile.

FoundationPõhi-API
AUTHBearer tokenJuurdepääs
POSTv1/customer/newKlient
POSTv1/card/tokenize/tokenTokenize
ENVsandbox / productionKeskkonnad
Tehingute API

Loodetavast maksust kogu tehingu tsüklis.

Keskendu Pix ja kaardi ja boleto tehingutega: loomis, küsimine, kinnipeamine, tühistamine, tagasimaksmine ja staatuse jälgimine.

MaksedTehingute API
POSTv1/transaction/new/:CustomerIDLoo
GETv1/transaction/get/:idVaata
CAPcaptura total ou parcialTõstmine
VOIDcancelamento / estornoCykle
Postman · Payment Links API V2

Muunda ülekandmine URL-ks.

API V2 hõlmab linkide loomist, küsitlust, värskendamist, kustutamist ja loetelu, samuti toodud tehingute küsitlust. Seada asendid, maksevahendid, osalemine, intressimäärad, kättesaadavus, Order Bump, visuaalne identiteet ja Split, kui see on võimaldatud.

V2 konfiguratsioonPayment Link
ITEMtitle + items[]Maksenõue
PAYcredit / pix / boletoMeetodid
TIMEopen_at / end_at / max_paymentsLisaldusvõime
KARDmax_installment + interestOsamaksed
BUMPorder_bump_items[]Lisenduspakkumine
BRANDprimary_color + bannersIdentiteet
SPLITsplit_rules[]Tülitamine
Postman · Sellers API

Osalejad käsitletakse kui arhitektuuri osa.

Vaadake konkreetset võrdlust, et rakendada platvormi Sellers-ga seotud funktsioone ja hoida seda rahalolekualust eraldi.

Postman Ühiskogus
Sellers APIplatvormi osalejad
Postman · Maksete Jaotamine

Pange oma viitega maksete jagamine.

Kasuta pühendatud kogum Maksete Jaotamine reegleid rakendamiseks mitmes osalejas, hoides seda laagrit eraldi API Baasi ja Tehingute API vahel.

Postman Ühiskogus
Maksete JaotamineMakse Split'i reeglid
Kulude Haldamine ja Ettevõtte Kaardid

Korporatiivjuhtimine, mis on seotud platvormiga.

ettevõtte kaardid emiteerimise ja haldamise pühendatud eespoolne, mille eesmärk on kehtestada piirmäärad, kasutada poliitika, kandjad ja jälgida kulude tegutsemist.

CorporateEttevõtte Kaardid
KARDemissão e gestão por empresaKaardid
RULLElimites e políticas de usoKontroll
TEAMportadores e centros de custoMeeskond
VIEWvisão consolidada de gastosTegevus
Quickstart

Esimest taotlusest
esimesel tasumisel.
Kolm sammu.

Seada autentimine, luua customer, ja hallata Pix tasust, kasutades sama voolu, mida teie rakendus toodab tootmiseks.

Esimene integreerimine

See on lühike tee API struktuuri mõistmiseks enne, kui kasutame teisi vahendeid.

Astu API Referents —
01
Aktiivne sammAutentifitseerida taotlusi
Käik 01 · juurdepääs

Autentifitseerida taotlusi

Iga integreerimine algab õigest keskkonda ja kehtivale autoreerimisheaderis olevale tokenile.

Bearer tokenSandboxTootmiskeskkond
Eesmärk

Teie rakendus räägib API IOPAY'ga tõestatud viisil.

Ootatav tagasitulek

Siit alates saate nimetada järgmised integratsiooni marsruudid.

Kuhu sa lähed

Iga integratsiooni alguses, enne kui luua kliente või tehinguid.

Kontrolinlist
  • Vali sandbox või tootmine.
  • Lõppida autoriseeringu: kandja seu_token.
  • Lähetada Content-Type: application/json.
Autentiseerimise näide
Docs —
curl --request GET \
  --url https://api.iopay.com.br/api/v1/customer/get/:customerId \
  --header 'Authorization: Bearer seu_token' \
  --header 'Content-Type: application/json'
Järgmine samm

Kui autentimine on valmis, siis järgmine samm on luua ostja, kes saab tasu.

Authorization: Bearer seu_token





Makse kuu

Integratsioon.Iga maksmine
oma oma reisi.

Pix, kaard ja boleto elavad tehingute keskmes. Makselingid'd kasutavad sama infrastruktuuri, nagu assisted sales, remote bilansing ja kanalid, millel ei ole oma kontrollit.

PIX

Pix

Minudi tasude loomine QR Code ja kinnituse jälgimine sündmuste kaupa.

Täiuslik kassavälja, kaugtasu ja otsekohe maksevoogude jaoks.
CC

Kaardid

Ühekordne krediitkaardimakse või osa, tokendamine ja tagasi ostmise või kordamise päevad.

See võimaldab ühendada omapärase kontrollimise ja tegevusloa voogudega.
BLT

Boleto

Tööpäevade eest, mis nõuavad titullide tasumist, maksmise ja jälgimise.

Võtmise staatust võib integreerida ettevõtte siseprotsessidele.
LNK

Makselingid

Looda API-i jaoks majutatud ja jagatavaid tasusid, mida müüa traditsioonilise kasumi väljapoole.

CRM, WhatsApp, sisemiste müügi, teenindamise ja assisteeritud makseteekonnad.


Webhooks & Events

Teie süsteem ei pea küsima.
Iopay annab mõne sekundi pärast teada.

HTTP POST reaalne aeg Mitte valimist

IOPAY saab makse uuendust, töötleb uut staatust ja saadab webhook oma lõpppunktile. Väike hõõrumine, selge voolu ja kohanenud süsteemid.

Loe webhooks laagri ja Iopay vastupidavate sündmustega automaatselt tagasiandmisega, kui teie server ei ole saadaval.

01 · päritolu Maksumäär muutub.

Uus infrastruktuuri areng.

→→→→→→→→→→→→→→
03 · Teie süsteem O webhook Lõpeta. Iga kord.

Teie lõpppunkt saab Iopay-lt POST-nõue ja te töötlete ja reageerite nagu soovite. Teie süsteem võtab meetmeid pärast makset, mis on loodud, heaks kiidetud, ebaõnnestunud, tagasi lükatud või osaliselt tühistatud. Võõrandamisega on teie süsteemis kõik, mida vaja, et vabastada taotlus, toita CRM&ERPid, tegelda SAP-iga, integreerida täispildimist ja maksutunnistust.

SDKs IOPAY

SDKs Java ja JavaScript Node.js ja
PHP / Laravel.

Kasutage IOPAY avalikke kliente Node.js ja PHP / Laravel või integreerige API REST kaudu otse igas keeles. Alustamiseks vähem katki, ilma et kaotaksid juurdepääsu platvormi HTTP lepingule.

Official SDK · Node.js

Valmis integreerimine JavaScript-i rakendustele.

Avalik klient autentimise, keskkonna, tokendamise, klientide ja peamiste tehingutega.

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

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

Koostage PHP'i või Laravel'i projektide jaoks.

Official package iopay-payments/sdk-php võib paigaldada Composeri kaudu ja kasutada projekti autoloodiga, sealhulgas Laravel rakendustes.

Installaatsioon komponeeri kaudu
composer require
iopay-payments/sdk-php

// disponível no vendor/autoload.php do projeto
REST API · mis tahes staak

Kasuta otsest HTTP-d, kui tahad täielikku kontrolli.

Python, Go, Java, .NET, Ruby või mis tahes muu staak saab API IOPAY tarbida otse HTTPS-i kaudu, kasutades samu avaldatud lõpppunkte ja lepinguid.

Üldine näide
curl --request GET \\
  --url https://api.iopay.com.br/api/v1/customer/get/:CustomerID \\
  --header 'Authorization: Bearer seu_token' \\
  --header 'Content-Type: application/json'
Tegevus

Integratsioon ja tegevus peavad rääkima sama keelt.

Pärast kasutuselevõttu peavad insenerid, tooted, rahandus ja teenindus nägema sama makset. IOPAY portaal täiendab API tehinguvälja, saajate, tunniste, aruannete ja operatiivse jälgimisega.

01Tehingud Vaadake tehingu staatust, kliendi, meetodit, väärtust ja viiteid.
02Laekuvad maksed Täidetav müügiga seotud finantsnägemist.
03Juurdepääsuandmed Keskendab integreerimiskeskkonna jaoks vajalikke andmeid.
04Aruanded Toeta operatsiooni ja lepitamise rutiine, olge mitte ainult inseneriteamilt sõltuv.
Operatsioon IOPAYKonsolideeritud nägemus
TEHINGUD883
KINNITAMINE60,4%
TPVR$ 2,58M
TehingMeetodStatusSumma
0b527...9a6creditTõidetudR$ 1.002
44d23...9044pixLängR$ 3.482
34fad...29e7creditTõidetudR$ 5.444
Turvalisus & arhitektuur kui aluspõhimõte

APIs Ja arhitektuur, mis on mõeldud toimimiseks
Maksed kontrolli, turvalisuse ja nägemisega.

Krediitlid, keskkonnasõbralik segreerimine, tokendamine ja turvakaitse on osa toote arhitektuuri ja vähendavad ebavajalikku esinemist tundlike andmetega.

01Seegreeritud krediidid

Eraldage arendamine, katsetamine ja tootmine iga keskkonna jaoks sobivate tunnustega.

02Tokeniseerimine

Vähendatakse tundlike andmete liikumist tagasiostmise, kordamise ja ühe klikki teel.

03PCI DSS 4.0.1

Maksete turvalisuse ja keskkonnakaitse kontrollimised IOPAY infrastruktuuri suhtes.

04Aeged ja jälgimine

Kasutage ID-d, staatust ja webhooks, et jälgida tehingut ja vastata eranditele.

Kasutamisjuhtumid

Arhitektuur erinevate inimeste jaoks
ärimudelid.

IOPAY on mõeldud toodete jaoks, kes vajavad maksude integreerimist e-kaubanduse enda kogemusse SaaS, marketplace, ERP ja abistatud müügi kaudu.

E-kaubandus

Oma kontrollikoda.

Kontrollige ostja kogemust, kui IOPAY töötab välja makse- ja sündmuste katme.

Vaata e-kaubanduse →
SaaS & recurrence

Kogu tasumine ja pidev tasumine.

See kombineerib oma rakenduse tokendamist, kliente, sündmusi ja loogikat korduvatele reisidele.

Vaata dokumentatsiooni →
Marketplaces

Sellers ja Split.

Võta arvesse Sellers ja Maksete Jaotamine reegleid tehinguvälja kohta.

Vaadake turuplaadid →
ERP & finance

Operatsiooniga seotud maksed.

Integreerige tasud ja sündmused sisemiste lepitus-, teenindus- ja finantsprotsessidega.

Hääle spetsialistiga →
Inside sales

- Tüülis on tasud.

Kasuta sidemeid või tehinguid CRM-st ja pöördke tagasi müügi-, onboarding- ja finantsturule.

Vide linkid →
White-label

Infrastruktuur teie kogemuste all.

Kombineerige APIs ja platvormi funktsioone, et pakkuda oma kaubamärgiga integreeritud maksetööd.

Vaata valge märgi →
Integratsioon ja APIs IO

Esimest kõnetest tootmiseni. Loodake parima maksete lahenduste arhitektuuri

Eksploreerige dokumente, proovige nende integreerimist ja kerge tehke oma toote sisemiste maksumisi IOPAY infrastruktuuri abil.