Przegląd
Base API skupia główny przepływ płatności: uwierzytelnianie, customers, karty/tokenizację i transakcje. Sellers i Split mają własne obszary, ponieważ obsługują operacje platformowe i podział środków.
Tożsamość wielokrotnego użytku.
Utwórz kupującego raz i używaj kontekstu w nowych ścieżkach.
Twórz i śledź płatności.
Pix, karty i boleto wchodzą w ten sam cykl transakcyjny API.
Mniejsza ekspozycja.
Powiąż instrumenty płatnicze z customerem dla ścieżek cyklicznych i ponownych zakupów.
Uwierzytelnianie
Wyślij email, secret i io_seller_id, aby uzyskać access_token. Używaj zwróconego tokenu w nagłówku Authorization kolejnych requestów.
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>"
}'access_token, token_type, token_scope i expires_in. Używaj access tokenu jako Authorization: Bearer your_token w kolejnych wywołaniach i nie ujawniaj danych uwierzytelniających ani tokenów we frontendzie, repozytorium ani publicznych logach.Podstawowy przepływ
Wyślij dane uwierzytelniające i uzyskaj access token.
Otrzymaj identyfikator wielokrotnego użytku dla ścieżki.
Utwórz Pix, kartę lub boleto powiązane z customerem.
Używaj zapytań po ID i webhooków, aby śledzić zmiany.
Utwórz customera
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"
}
}'Utwórz transakcję Pix
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": "Zamówienie #102938",
"statement_descriptor": "IOPAY STORE",
"io_seller_id": "<IO_SELLER_ID>",
"payment_type": "pix",
"reference_id": "order_102938"
}'Zasoby
| Obszar | Zastosowanie | Kolejna referencja |
|---|---|---|
| Customers | Rejestracja, wyszukiwanie i tożsamość płatnika. | Base API |
| Karty / tokenizacja | Instrumenty powiązane z customerem i ponowne zakupy. | Base API |
| Transakcje | Tworzenie, wyszukiwanie, przechwycenie i anulowanie. | Base API |
| Pix | Płatność, identyfikatory i śledzenie statusu. | Base API + Webhooki |
| Boleto | Tworzenie i cykl płatności boleto. | Base API + Webhooki |
| Sellerzy | Uczestnicy platformy / marketplace'u. | Sellers API → |
| Split | Podział między uczestników. | Split API → |