Developer platform

API on tuum.

Kogemus jääb sinu omaks.

Ehita maksed otse oma tootesse. REST API customeritele, kaartidele, Pixile, boletole ja krediidile, SDK-de, webhookide ning eraldi viidetega tehingute, makselinkide, sellerite, maksete jaotuse ja kulude halduse jaoks.

REST APITootmineSandboxWebhooksKaardid kuni 21xPixBoletoTokeniseerimine ja ost ühe klõpsugaMakselingidMaksete jaotus (Split)
IOPAY dokumentatsioon

Dokumenteeritud ja korrastatud API-d ning integratsiooniviited

Laienda makseteenuseid ja -tooteid teenusena. Alusta Base API-st ja liigu oma rakenduse spetsiifilise viite juurde. Tehingud, makselingid, sellerid, maksete jaotus, päringud, tokeniseerimine ja kulude haldus on korrastatud nii, et jõuad kiiresti õige viiteni.

docs-api.iopay.com.br
Avalik dokumentatsioon
Base API

Sinu integratsiooni alus.

Alusta autentimisest, keskkonna seadistusest, customeritest, kaartidest ja tokeniseerimisest. Tehingukiht tuleb järgmises etapis.

FoundationBase API
AUTHBearer tokenJuurdepääs
POST/api/v1/customer/newCustomer
POST/api/v1/card/tokenize/tokenTokenize
ENVsandbox / productionKeskkonnad
Tehingu-API

Loodud maksest kuni tehingu täieliku elutsüklini.

Koonda siia Pixi, kaardi ja boleto tehingutoimingud: loomine, päring, vastuvõtt, tühistamine, tagastamine ja staatuse jälgimine.

PaymentsTehingu-API
POST/api/v1/transaction/new/:CustomerIDLoo
GET/api/v1/transaction/get/:idPäri
CAPtäielik või osaline vastuvõttVastuvõtt
VOIDtühistamine / tagastamineElutsükkel
Postman · Payment Links API V2

Muuda maksenõue URL-iks.

API V2 koondab linkide loomise, päringu, uuendamise, kustutamise ja loetlemise ning nende loodud tehingute päringu. Seadista tooted, makseviisid, osamaksed, intress, kättesaadavus, Order Bump, visuaalne identiteet ja Split, kui see on lubatud.

V2 seadistusPayment Link
ITEMtitle + items[]Maksenõue
PAYcredit / pix / boletoMeetodid
TIMEopen_at / end_at / max_paymentsKättesaadavus
CARDmax_installment + interestOsamaksed
BUMPorder_bump_items[]Lisapakkumine
BRANDprimary_color + bannersIdentiteet
SPLITsplit_rules[]Jaotus
Postman · Sellers API

Osalised kui arhitektuuri osa.

Vaata eraldi viidet, et rakendada platvormi selleritega seotud ressursse ja hoida see kiht tehingutuumast eraldi.

Postman Public collection
Sellers APIplatvormi osalised
Postman · Maksete jaotus

Maksete jaotus oma viitega.

Kasuta eraldi kollektsiooni maksete jaotuse reeglite rakendamiseks mitme osalisega toimingutes, hoides selle kihi Base API-st ja tehingu-API-st eraldi.

Postman Public collection
Maksete jaotus (Split)maksete jaotuse reeglid
Kulude haldus & ärikaardid

Platvormiga ühendatud ettevõtte kontroll.

Eraldi suund ärikaartide väljastamiseks ja haldamiseks, limiitide, kasutuspoliitikate, kaardiomanike määramiseks ja kulutoimingute jälgimiseks.

CorporateÄrikaardid
CARDväljastamine ja haldus ettevõtte kaupaKaardid
RULElimiidid ja kasutuspoliitikadKontroll
TEAMkaardiomanikud ja kulukeskusedMeeskond
VIEWkulude koondvaadeToiming
Quickstart

Esimesest requestist
esimese maksenõudeni.Kolme sammuga.

Seadista autentimine, loo customer ja loo Pix-maksenõue sama vooga, mille sinu rakendus tootmisse viib.

Samm01/ 03 ·Autendi requestid
Samm 01 · Juurdepääs

Autendi requestid

Iga integratsioon algab sinu tunnuste autentimisega, et saada API juurdepääsutoken.

Bearer TokenTransaction3600s
Mida selles etapis teha
  • Saada email, secret ja io_seller_id.
  • Võta vastu access_token.
  • Kasuta Bearer Tokenit järgmistes requestides.
Mõista seda etappi
Eesmärk
Sinu rakendus hakkab IOPAY API-ga autenditult suhtlema.
Oodatav vastus
Juurdepääsutoken järgmiste requestide autentimiseks.
Kus see sobitub
Integratsiooni alguses, enne customerite, kaartide või tehingute kasutamist.
Autentimise näide
Docs ↗

        
Näidisvastus · JSON
Järgmine samm

Kui autentimine on valmis, on järgmine samm luua ostja, kellele maksenõue esitatakse.





Makseviisid

Üks integratsioon.Igal maksel
oma teekond.

Pix, kaart ja boleto elavad tehingutuumas. Makselingid viivad sama infrastruktuuri toetatud müüki, kaugmaksenõuetesse ja kanalitesse, millel pole oma checkouti.

PIX

Pix

Kiirmaksete loomine, QR-kood ja kinnituse jälgimine sündmuste kaudu.

Ideaalne checkouti, kaugmaksenõuete ja kohese makse voogude jaoks.
CC

Kaardid

Ühekordne või osamaksetega krediit, tokeniseerimine ning kordusostu- või korduvmaksete teekonnad.

Võimaldab ühendada oma checkouti toimingu autoriseerimisvoogudega.
BLT

Boleto

Maksenõuete väljastamine ja jälgimine teekondadele, mis nõuavad makset arve alusel.

Maksenõude staatust saab lõimida ettevõtte sisemiste protsessidega.
LNK

Makselingid

Loo majutatud ja jagatavaid maksenõudeid API kaudu, et müüa väljaspool traditsioonilist checkouti.

CRM, WhatsApp, inside sales, klienditeenindus ja toetatud teekonnad.


Webhookid ja sündmused

Sinu süsteem ei pea küsima.
Iopay teatab sekunditega.

HTTP POST Reaalajas Ilma pollinguta

IOPAY saab makse uuenduse, töötleb uue oleku ja saadab webhooki sinu lõpp-punkti. Vähe hõõrdumist, selge voog ja sünkroniseeritud süsteemid.

Toetu Iopay töökindlale webhookide ja sündmuste kihile, mis edastab automaatselt uuesti, kui sinu server pole kättesaadav.

01 · Allikas Makse muutub.

Uus olek infrastruktuuris.

→→→→→→→→→→→→→→
03 · Sinu süsteem Webhook jõuab kohale. Alati.

Sinu lõpp-punkt saab Iopaylt POST-requesti ning sina töötled ja reageerid, nagu soovid. Sinu süsteem tegutseb pärast makse loomist, kinnitamist, ebaõnnestumist, tagastamist või osalist tühistamist. Kinnitusega on sinu süsteemil kõik olemas, et vabastada tellimus, toita CRM-i ja ERP-sid, suhelda SAP-iga ning lõimida fulfillment ja arveldamine.

SDKs IOPAY

SDK-d Javale, Javascriptile, Node.js-ile ja
PHP-le / Laravelile.

Kasuta IOPAY avalikke kliente Node.js-is ja PHP-s / Laravelis või lõimi otse REST API kaudu mis tahes keeles. Vähem boilerplate'i alustamiseks, kaotamata juurdepääsu platvormi HTTP-lepingule.

Ametlik SDK · Node.js

Valmis integratsioon JavaScripti rakendustele.

Avalik klient autentimise, keskkondade, tokeniseerimise, customerite ja peamiste tehingutoimingutega.

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

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

Composer PHP- või Laraveli projektidele.

Ametliku paketi iopay-payments/sdk-php saab paigaldada Composeriga ja kasutada projekti autoloadi kaudu, ka Laraveli rakendustes.

Paigaldus Composeriga
composer require
iopay-payments/sdk-php

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

Kasuta otse HTTP-d, kui soovid täielikku kontrolli.

Python, Go, Java, .NET, Ruby või mis tahes muu stack saab IOPAY API-t kasutada otse HTTPS-i kaudu, samade avaldatud lõpp-punktide ja lepingutega.

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

Integratsioon ja toimingud peavad rääkima sama keelt.

Pärast juurutamist peavad arendus, toode, rahandus ja klienditeenindus nägema sama makset. IOPAY portaal täiendab API-t tehinguvaate, nõuete, tunnuste, aruannete ja tegevuse jälgimisega.

01Tehingud Vaata staatust, klienti, meetodit, summat ja toimingu viiteid.
02Nõuded Jälgi töödeldud müügiga seotud finantsvaadet.
03Tunnused Koonda integratsioonikeskkondade jaoks vajalikud andmed.
04Aruanded Toeta tegevus- ja kooskõlastusrutiine ilma ainult arendusmeeskonnast sõltumata.
IOPAY toimingudKoondvaade
TEHINGUD883
KINNITAMINE60,4%
TPVR$ 2,58 mln
TehingMeetodStaatusSumma
0b527...9a6creditKinnitatudR$ 1 002
44d23...9044pixOotelR$ 3 482
34fad...29e7creditKinnitatudR$ 5 444
Turvalisus & arhitektuur kui tuum ja alusprintsiip

API-d ja arhitektuur, mis on loodud käitama
makseid kontrolli, turvalisuse ja ülevaatega.

Tunnused, keskkondade eraldamine, tokeniseerimine ja turvakontrollid on toote arhitektuuri osa ning vähendavad tundlike andmete tarbetut avatust.

01Eraldatud tunnused

Eralda arendus, testimine ja tootmine igale keskkonnale sobivate tunnustega.

02Tokeniseerimine

Vähenda tundlike andmete liikumist kordusostu, korduvmaksete ja one-click teekondadel.

03PCI DSS 4.0.1

Turvakontrollid ja maksekeskkonna kaitse IOPAY infrastruktuuris.

04Sündmused ja jälgitavus

Kasuta identifikaatoreid, staatusi ja webhooke tehingu elutsükli jälgimiseks ja eranditele reageerimiseks.

Kasutusjuhud

Arhitektuur erinevatele
ärimudelitele.

IOPAY Developer Platform on loodud toodetele, mis peavad makseid oma kogemusse põimima, e-kaubandusest SaaS-i, turuplatsi, ERP ja toetatud müügini.

E-kaubandus

Oma checkout.

Kontrolli ostja kogemust, samal ajal kui IOPAY käitab maksete ja sündmuste kihti.

Vaata e-kaubandust →
SaaS & korduvmaksed

Kordusost ja pidev arveldamine.

Ühenda tokeniseerimine, customerid, sündmused ja oma rakenduse loogika korduvate teekondade jaoks.

Vaata dokumentatsiooni →
Turuplatsid

Sellerid ja maksete jaotus.

Too sellerite kontekst ja maksete jaotuse reeglid tehinguvoogu.

Vaata turuplatse →
ERP & rahandus

Toimingutega ühendatud maksed.

Lõimi maksenõuded ja sündmused sisemistesse kooskõlastus-, teenindus- ja rahandusprotsessidesse.

Räägi eksperdiga →
Inside sales

Maksenõue lehtri sees.

Loo CRM-ist linke või tehinguid ja tagasta staatus müügile, onboardingule ja rahandusele.

Vaata linke →
White-label

Infrastruktuur sinu kogemuse all.

Ühenda API-d ja platvormiressursid, et pakkuda sinu brändiga lõimitud maksete teekondi.

Vaata white-label'it →
IO integratsioon ja API-d

Esimesest kutsest tootmiseni. Toetu parimale makselahenduste arhitektuurile

Uuri dokumentatsiooni, testi oma integratsiooni ja too maksed oma tootesse IOPAY infrastruktuuriga.