Ülevaade
Ülevaade
API Base keskendab peamist maksevoogu: autentiseerimist, kliente, kaarte/tokeneerimist ja tehinguid. Sellers ja Split omavad oma pinnad, sest nad tegelevad platvormi- ja jaotamisoperatsioonidega.
Kasutatav identiteet.
Looda ostja kord ja kasuta konteksti uuesti uute reiside käigus.
Looda ja jälgi oma makseid.
Pix, kaart ja boleto lähevad sama tehinguperioodi kui API.
Vähem nähtust.
Kasutage customerga korduvate reiside ja tagasi ostmise maksetevahendid.
Authentification
Authentification
Saadke headeris kehtiv toki Authorization ja kasutage JSON-i integreerimise palgalõudes.
Autentiseerimise 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'
Ambientes. Eraldage arendustegevuse/testide ja tootmise tunnused. Ärge esita näiteid frontendil, hoiustuses või avalikel logidel.
Quickstart
Baasivoog
Võtke valiku ja saatke Bearer'i.
Saad reisi jaoks taaskasutatav ID.
Loe Pix, kaard või boleto koos customerga.
Kasuta ID- ja webhooks küsitlust muutuste jälgimiseks.
Loo customer
POST /api/v1/customer/new
curl --request POST \
--url https://api.iopay.com.br/api/customer/new \
--header 'Authorization: Bearer seu_token' \
--header 'Content-Type: application/json' \
--data '{
"name": "Maria Oliveira",
"email": "[email protected]",
"document": "12345678909",
"phone_number": "+5511999999999"
}'Loe Pix'i tehing
POST /api/v1/transaction/new/:CustomerID
curl --request POST \
--url https://api.iopay.com.br/api/v1/transaction/new/:CustomerID \
--header 'Authorization: Bearer seu_token' \
--header 'Content-Type: application/json' \
--data '{
"amount": 12990,
"payment_method": "pix",
"reference_id": "order_102938"
}'Integratsiooni näited. Hoia marsruudid, valdkonnad ja näited kohanedes kehtivate rakendustega enne muudatuste avaldamist.
Ressursside kaart
Funktsioonid
| Area | Kasuta | Nägemine viide |
|---|---|---|
| Kustomendid | Registreerimine, küsitlus ja maksja identiteet. | Põhi-API |
| Kardid / tokendamine | Kohasised vahendid customer ja osta uuesti. | Põhi-API |
| Tehingud | Loomine, vaatamine, kinnipeamine ja kustutamine. | Põhi-API |
| Pix | Maksmine, tunnused ja staatuse jälgimine. | API Base + Webhooks |
| Boleto | Pangakogumise loomine ja tsükli. | API Base + Webhooks |
| Sellers | Platvormi / turukeskuse osalejad. | Sellers API → |
| Split | Osalejate vaheline jaotamine. | Split API → |