Yleiskuva
Yleiskuva
API-tukikohdassa keskitytään maksuliikenteen päävirtaan: tunnistautumiseen, asiakkaisiin, kortteihin/vedonlyöntiin ja maksutapahtumiin. Sellers ja Split ovat omia pintojaan, koska ne palvelevat alusta- ja jakelutoimintoja.
Uudelleenkäytettävä identiteetti.
Luo ostaja kerran ja hyödynnä kontekstia uusilla matkoilla.
Luo ja seuraa maksuja.
Pix, kortti ja boleto tulevat samaan tapahtumasykliin kuin API.
Vähemmän julkisuutta.
Liitä maksuvälineet customer:een toistuvia matkoja ja takaisinostoa varten.
Todentaminen
Todentaminen
Lähetä kelvollinen kuponki otsikkoon Authorization ja käyttää JSON:ta integraation hyötykuormassa.
Esimerkki varmennuksesta
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. Erilliset kehittämis-/testaus- ja tuotantotiedot. Älä näytä kuponkeja etupuolella, arkistossa tai julkisissa lokikirjoissa.
Pikakäynnistys
Perusvirta
Valitkaa ympäristö ja lähettäkää Lauttamies-kyltti.
Matkaa varten saa uudelleenkäytettävän henkkarin.
Luo Pix, kortti tai boleto customer:een liitettynä.
Muutosten seuraamiseen käytetään ID- ja webhooks-tunnusta.
customer:n luominen
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"
}'Pix-tapahtuman luominen
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"
}'Integraation esimerkkejä. Pidä reitit, kentät ja esimerkit ajan tasalla nykyisen toteutuksen kanssa ennen muutosten lähettämistä.
Resurssikartta
Ominaisuudet
| Alue | Käyttö | Seuraava viittaus |
|---|---|---|
| Asiakkaat | Maksajan rekisteröinti, tarkastus ja henkilöllisyys. | Perus-API |
| Kortti / kuponki | customer-laitteeseen liittyvät instrumentit ja takaisinostot. | Perus-API |
| Tapahtumat | Luominen, konsultointi, vangitseminen ja peruuttaminen. | Perus-API |
| Pix | Lataus, tunnistus ja statuksen seuranta. | Perus API + webhooks |
| Boleto | Pankkien keräämisen luominen ja kierto. | Perus API + webhooks |
| Sellers | Alustan/torin osallistujat. | Sellers API → |
| Split | Jakautuminen osallistujien kesken. | Jaa API |