IOPAY→Deweloperzy→Podstawowe API
Główny API

Podstawowe API

Wewnętrzna odniesienie do organizowania głównego przepływu API IOPAY: uwierzytelnianie, klienci, instrumenty płatnicze i transakcje.

Baza URLhttps://api.iopay.com.br/api/
AutentykęBearer token
WzorzecJSON
Szybki start Widać zasoby Webhooks →
Przegląd

Przegląd

API Base koncentruje się na głównym przepływie płatności: uwierzytelnianiu, klientom, kartach/tokenizacji i transakcjach. Sellers i Split posiadają własne powierzchnie, ponieważ obsługują operacje platformy i dystrybucji.

Klienci

Tożsamość ponownie używalna.

Wystarczy stworzyć nabywcę raz i ponownie wykorzystać kontekst w kolejnych podróżach.

Transakcje

Stwórz i śledź płatności.

Pix, karta i boleto wchodzą w ten sam cykl transakcyjny z API.

Tokenizacja

Mniej ekspozycji.

Przywiązać instrumenty płatnicze do customer dla podróży powtarzających się i odkupujących.

Autentykę

Autentykę

Wysyłać ważny token w header Authorization i użyj JSON w ładowaniach integracyjnych.

Przykład uwierzytelniania
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. Oddzielić akredytacje rozwoju/testów od produkcji. Nie wystawiaj tokenów w frontendze, repozytorium ani publicznych dziennikach.
Szybki start

Wpływ podstawowy

01 · DostępAutentique.

Wybierz środowisko i wysłać token Bearera.

02 · KlientStwórz kupca.

Otrzymuj identyfikator, który może być używany ponownie na podróż.

03 · TransakcjaZarządza płatnością.

Tworz Pix, kartę lub boleto związaną z customer.

04 · StanSincronize.

Użyj wyszukiwania ID i webhooks do monitorowania zmian.

Tworzenie klienta

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"
  }'

Tworzenie transakcji Pix

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"
  }'
Przykłady integracji. Trzymaj szlaki, pola i przykłady w synchronizacji z aktualną implementacją przed publikowaniem zmian.
Mapa zasobów

Funkcje

ObszarUżycieKolejny odniesienie
KlienciRejestr, wizyta i tożsamość płatnika.Podstawowe API
Karty / tokenizacjaInstrumenty związane z customer I kup to.Podstawowe API
TransakcjeTworzenie, przeglądanie, schwytanie i odwołanie.Podstawowe API
PixWynagrodzenie, identyfikatory i monitorowanie statusu.API Bazy + Webhooks
BoletoTworzenie i cyklu pobrania banków.API Bazy + Webhooks
SellersUczestnicy platformy/marketplacu.Sellers API →
SplitRozdział między uczestnikami.Split API →