Ülevaade
Ülevaade
Base API koondab peamise maksevoo: autentimine, customerid, kaardid/tokeniseerimine ja tehingud. Sellersil ja Splitil on oma pinnad, sest need teenindavad platvormi- ja jaotustoiminguid.
Korduvkasutatav identiteet.
Loo ostja üks kord ja kasuta konteksti uutel teekondadel uuesti.
Loo ja jälgi makseid.
Pix, kaart ja boleto sisenevad API samasse tehingutsüklisse.
Vähem avatust.
Seo makseinstrumendid customeriga korduvate ja kordusostu teekondade jaoks.
Autentimine
Autentimine
Saada email, secret ja io_seller_id, et saada access_token. Kasuta tagastatud tokenit järgmiste requestide Authorization päises.
POST /auth/login
curl --request POST \
--url https://api.iopay.com.br/api/auth/login \
--header 'Content-Type: application/json' \
--data '{
"email": "your_email",
"secret": "your_secret",
"io_seller_id": "<IO_SELLER_ID>"
}'Bearer Token. Autentimine tagastab
access_token, token_type, token_scope ja expires_in. Kasuta access tokenit kujul Authorization: Bearer your_token järgmistes kutsetes ning ära avalikusta tunnuseid ega tokeneid frontendis, hoidlas ega avalikes logides.Quickstart
Põhivoog
Saada oma tunnused ja hangi access token.
Saa teekonna jaoks korduvkasutatav identifikaator.
Loo customeriga seotud Pix, kaart või boleto.
Kasuta ID-põhist päringut ja webhooke muudatuste jälgimiseks.
Loo customer
POST /v1/customer/new
curl --request POST \
--url https://api.iopay.com.br/api/v1/customer/new \
--header 'Authorization: Bearer your_token' \
--header 'Content-Type: application/json' \
--data '{
"first_name": "Maria",
"last_name": "Oliveira",
"customer_type": "person_natural",
"email": "[email protected]",
"taxpayer_id": "12345678909",
"phone_number": "+5511999999999",
"address": {
"line1": "Av. Paulista, 1000",
"line2": "Apto 101",
"neighborhood": "Bela Vista",
"city": "São Paulo",
"state": "SP",
"postal_code": "01310100",
"country_code": "BR"
}
}'Loo Pix-tehing
POST /v1/transaction/new/:CustomerID
curl --request POST \
--url https://api.iopay.com.br/api/v1/transaction/new/:CustomerID \
--header 'Authorization: Bearer your_token' \
--header 'Content-Type: application/json' \
--data '{
"amount": 12990,
"currency": "BRL",
"description": "Tellimus #102938",
"statement_descriptor": "IOPAY STORE",
"io_seller_id": "<IO_SELLER_ID>",
"payment_type": "pix",
"reference_id": "order_102938"
}'Integratsiooni näited. Hoia marsruudid, väljad ja näited enne muudatuste avaldamist kehtiva rakendusega sünkroonis.
Ressursside kaart
Ressursid
| Valdkond | Kasutus | Järgmine viide |
|---|---|---|
| Customerid | Maksja registreerimine, päring ja identiteet. | Base API |
| Kaardid / tokeniseerimine | Customeriga seotud instrumendid ja kordusost. | Base API |
| Tehingud | Loomine, päring, vastuvõtt ja tühistamine. | Base API |
| Pix | Maksenõue, identifikaatorid ja staatuse jälgimine. | Base API + Webhookid |
| Boleto | Pangaarve maksenõude loomine ja elutsükkel. | Base API + Webhookid |
| Sellerid | Platvormi / turuplatsi osalised. | Sellers API → |
| Split | Jaotus osaliste vahel. | Split API → |