Yleiskatsaus
Yleiskatsaus
Base API kokoaa päämaksuvirran: tunnistautumisen, customerit, kortit/tokenisoinnin ja tapahtumat. Sellersillä ja Splitillä on omat pintansa, koska ne palvelevat alusta- ja jakotoimintoja.
Uudelleenkäytettävä identiteetti.
Luo ostaja kerran ja käytä kontekstia uudelleen uusilla poluilla.
Luo ja seuraa maksuja.
Pix, kortti ja boleto kulkevat API:n samassa tapahtumasyklissä.
Vähemmän altistumista.
Liitä maksuvälineet customeriin toistuvia ja uusintaostopolkuja varten.
Tunnistautuminen
Tunnistautuminen
Lähetä email, secret ja io_seller_id saadaksesi access_token:n. Käytä palautettua tokenia seuraavien requestien Authorization-headerissa.
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. Tunnistautuminen palauttaa
access_token, token_type, token_scope ja expires_in. Käytä access tokenia muodossa Authorization: Bearer your_token seuraavissa kutsuissa äläkä paljasta tunnisteita tai tokeneita frontendissä, repositoriossa tai julkisissa lokeissa.Quickstart
Perusvirta
Lähetä tunnisteesi ja hanki access token.
Saat polulle uudelleenkäytettävän tunnisteen.
Luo customeriin liitetty Pix, kortti tai boleto.
Käytä ID-kyselyä ja webhookeja muutosten seurantaan.
Luo 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"
}
}'Luo Pix-tapahtuma
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": "Tilaus #102938",
"statement_descriptor": "IOPAY STORE",
"io_seller_id": "<IO_SELLER_ID>",
"payment_type": "pix",
"reference_id": "order_102938"
}'Integraatioesimerkit. Pidä reitit, kentät ja esimerkit synkronoituina nykyisen toteutuksen kanssa ennen muutosten julkaisua.
Resurssikartta
Resurssit
| Alue | Käyttö | Seuraava referenssi |
|---|---|---|
| Customerit | Maksajan rekisteröinti, kysely ja identiteetti. | Base API |
| Kortit / tokenisointi | Customeriin liitetyt välineet ja uusintaosto. | Base API |
| Transaktiot | Luonti, kysely, veloitus ja peruutus. | Base API |
| Pix | Veloitus, tunnisteet ja tilan seuranta. | Base API + Webhookit |
| Boleto | Pankkiveloituksen luonti ja elinkaari. | Base API + Webhookit |
| Myyjät | Alustan / markkinapaikan osapuolet. | Sellers API → |
| Split | Jako osapuolten kesken. | Split API → |