Developer platform

API to rdzeń.

Doświadczenie pozostaje Twoje.

Buduj płatności bezpośrednio w swoim produkcie. REST API dla customers, kart, Pix, boleto i kredytu, z SDK, webhookami i dedykowanymi referencjami dla Transakcji, Linków do płatności, Sellerów, Split płatności i Zarządzania wydatkami.

REST APIProdukcjaSandboxWebhooksKarty do 21xPixBoletoTokenizacja i zakup jednym kliknięciemLinki do płatnościSplit płatności
Dokumentacja IOPAY

Udokumentowane i uporządkowane API oraz referencje integracji

Rozszerzaj produkty i usługi płatnicze jako usługę. Zacznij od Base API i przejdź do referencji właściwej dla Twojej implementacji. Transakcje, Linki do płatności, Sellerzy, Split płatności, Zapytania, Tokenizacja i Zarządzanie wydatkami są uporządkowane, abyś szybko trafił do właściwej referencji.

docs-api.iopay.com.br
Dokumentacja publiczna
Base API

Fundament Twojej integracji.

Zacznij od uwierzytelniania, konfiguracji środowiska, customers, kart i tokenizacji. Warstwa transakcyjna pojawia się w kolejnym etapie.

FoundationBase API
AUTHBearer tokenDostęp
POST/api/v1/customer/newCustomer
POST/api/v1/card/tokenize/tokenTokenize
ENVsandbox / productionŚrodowiska
API transakcyjne

Od utworzonej płatności do pełnego cyklu transakcji.

Skup tutaj operacje transakcyjne Pix, kart i boleto: tworzenie, wyszukiwanie, przechwycenie, anulowanie, zwrot i śledzenie statusu.

PaymentsAPI transakcyjne
POST/api/v1/transaction/new/:CustomerIDUtwórz
GET/api/v1/transaction/get/:idSprawdź
CAPprzechwycenie pełne lub częściowePrzechwycenie
VOIDanulowanie / zwrotCykl
Postman · Payment Links API V2

Zamień płatność w URL.

API V2 obejmuje tworzenie, wyszukiwanie, aktualizację, usuwanie i listowanie linków oraz wyszukiwanie wygenerowanych transakcji. Skonfiguruj pozycje, metody płatności, raty, odsetki, dostępność, Order Bump, tożsamość wizualną i Split, gdy jest włączony.

Konfiguracja V2Payment Link
ITEMtitle + items[]Płatność
PAYcredit / pix / boletoMetody
TIMEopen_at / end_at / max_paymentsDostępność
CARDmax_installment + interestRaty
BUMPorder_bump_items[]Dodatkowa oferta
BRANDprimary_color + bannersTożsamość
SPLITsplit_rules[]Podział
Postman · Sellers API

Uczestnicy traktowani jako część architektury.

Skorzystaj z dedykowanej referencji, aby wdrożyć zasoby związane z Sellerami platformy i utrzymać tę warstwę oddzieloną od rdzenia transakcyjnego.

Postman Public collection
Sellers APIuczestnicy platformy
Postman · Split płatności

Split płatności z własną referencją.

Użyj dedykowanej kolekcji, aby wdrożyć reguły Split płatności w operacjach z wieloma uczestnikami, utrzymując tę warstwę oddzieloną od Base API i API transakcyjnego.

Postman Public collection
Split płatnościreguły Split płatności
Zarządzanie wydatkami & Karty firmowe

Kontrola korporacyjna połączona z platformą.

Dedykowany obszar do wydawania i zarządzania kartami firmowymi, ustalania limitów, zasad użycia, posiadaczy kart i śledzenia operacji wydatkowych.

CorporateKarty firmowe
CARDwydawanie i zarządzanie według firmyKarty
RULElimity i zasady użyciaKontrola
TEAMposiadacze kart i centra kosztówZespół
VIEWskonsolidowany widok wydatkówOperacje
Quickstart

Od pierwszego requestu
do pierwszej płatności.W trzech krokach.

Skonfiguruj uwierzytelnianie, utwórz customera i wygeneruj płatność Pix, korzystając z tego samego przepływu, który Twoja aplikacja przeniesie na produkcję.

Krok01z 03 ·Uwierzytelnij requesty
Krok 01 · Dostęp

Uwierzytelnij requesty

Każda integracja zaczyna się od uwierzytelnienia danych, aby uzyskać token dostępu do API.

Bearer TokenTransaction3600s
Co zrobić na tym etapie
  • Wyślij email, secret i io_seller_id.
  • Odbierz access_token.
  • Używaj Bearer Token w kolejnych requestach.
Zrozum ten etap
Cel
Twoja aplikacja zaczyna komunikować się z API IOPAY w sposób uwierzytelniony.
Oczekiwana odpowiedź
Token dostępu do uwierzytelniania kolejnych requestów.
Gdzie się mieści
Na początku integracji, przed dostępem do customers, kart lub transakcji.
Przykład uwierzytelniania
Docs ↗

        
Przykładowa odpowiedź · JSON
Następny krok

Po uwierzytelnieniu kolejnym krokiem jest utworzenie kupującego, który otrzyma płatność.





Metody płatności

Jedna integracja.Każda płatność,
własna ścieżka.

Pix, karty i boleto działają w rdzeniu transakcyjnym. Linki do płatności przenoszą tę samą infrastrukturę do sprzedaży wspomaganej, płatności zdalnych i kanałów bez własnego checkoutu.

PIX

Pix

Tworzenie płatności natychmiastowych, kodu QR i śledzenie potwierdzenia przez zdarzenia.

Idealne dla checkoutu, płatności zdalnych i przepływów płatności natychmiastowych.
CC

Karty

Kredyt jednorazowy lub ratalny, tokenizacja i ścieżki ponownych zakupów lub płatności cyklicznych.

Pozwala łączyć własny checkout z przepływami autoryzacji operacji.
BLT

Boleto

Wystawianie i śledzenie płatności dla ścieżek wymagających zapłaty dokumentem boleto.

Stan płatności można zintegrować z procesami wewnętrznymi firmy.
LNK

Linki do płatności

Twórz hostowane, udostępnialne płatności przez API, aby sprzedawać poza tradycyjnym checkoutem.

CRM, WhatsApp, inside sales, obsługa klienta i ścieżki wspomagane.


Webhooki i zdarzenia

Twój system nie musi pytać.
Iopay powiadamia w kilka sekund.

HTTP POST Czas rzeczywisty Bez pollingu

IOPAY otrzymuje aktualizację płatności, przetwarza nowy stan i wysyła webhook do Twojego endpointu. Małe tarcie, jasny przepływ i zsynchronizowane systemy.

Skorzystaj z odpornej warstwy webhooków i zdarzeń Iopay z automatycznym ponownym dostarczaniem w przypadku niedostępności Twojego serwera.

01 · Źródło Płatność się zmienia.

Nowy stan w infrastrukturze.

→→→→→→→→→→→→→→
03 · Twój system Webhook dociera. Zawsze.

Twój endpoint otrzymuje request POST od Iopay, a Ty przetwarzasz go i reagujesz tak, jak chcesz. Twój system podejmuje działania po utworzeniu, zatwierdzeniu, niepowodzeniu, zwrocie lub częściowym anulowaniu płatności. Dzięki potwierdzeniu Twój system ma wszystko, by zwolnić zamówienie, zasilić CRM i ERP, współpracować z SAP, zintegrować fulfillment i fakturowanie.

SDKs IOPAY

SDK dla Java, Javascript, Node.js i
PHP / Laravel.

Używaj publicznych klientów IOPAY w Node.js i PHP / Laravel lub integruj się bezpośrednio przez REST API w dowolnym języku. Mniej boilerplate'u na start, bez utraty dostępu do kontraktu HTTP platformy.

Oficjalne SDK · Node.js

Gotowa integracja dla aplikacji JavaScript.

Publiczny klient z uwierzytelnianiem, środowiskami, tokenizacją, customers i głównymi operacjami transakcyjnymi.

Instalacja
npm install
@iopay-payments/iopay-api-sdk-nodejs

// depois, use o client IOPAY no projeto
Oficjalne SDK · PHP

Composer dla projektów PHP lub Laravel.

Oficjalny pakiet iopay-payments/sdk-php można zainstalować przez Composer i używać przez autoload projektu, także w aplikacjach Laravel.

Instalacja przez Composer
composer require
iopay-payments/sdk-php

// disponível no vendor/autoload.php do projeto
REST API · dowolny stack

Używaj bezpośrednio HTTP, gdy chcesz pełnej kontroli.

Python, Go, Java, .NET, Ruby lub dowolny inny stack mogą korzystać z API IOPAY bezpośrednio przez HTTPS, używając tych samych opublikowanych endpointów i kontraktów.

Przykład uniwersalny
curl --request GET \\
  --url https://api.iopay.com.br/api/v1/customer/get/:CustomerID \\
  --header 'Authorization: Bearer your_token' \\
  --header 'Content-Type: application/json'
Operacje

Integracja i operacje muszą mówić tym samym językiem.

Po wdrożeniu inżynieria, produkt, finanse i obsługa klienta muszą widzieć tę samą płatność. Portal IOPAY uzupełnia API o widok transakcyjny, należności, dane uwierzytelniające, raporty i śledzenie operacyjne.

01Transakcje Sprawdzaj status, klienta, metodę, kwotę i odniesienia operacji.
02Należności Śledź widok finansowy powiązany z przetworzoną sprzedażą.
03Dane uwierzytelniające Centralizuj dane potrzebne dla środowisk integracyjnych.
04Raporty Wspieraj rutyny operacyjne i uzgadniania rozliczeń bez polegania wyłącznie na zespole inżynierskim.
Operacje IOPAYWidok skonsolidowany
TRANSAKCJE883
AKCEPTACJA60,4%
TPVR$ 2,58 mln
TransakcjaMetodaStatusKwota
0b527...9a6creditZatwierdzonaR$ 1 002
44d23...9044pixOczekującaR$ 3 482
34fad...29e7creditZatwierdzonaR$ 5 444
Bezpieczeństwo & architektura jako rdzeń i zasada założycielska

API i architektura zaprojektowane do obsługi
płatności z kontrolą, bezpieczeństwem i wglądem.

Dane uwierzytelniające, separacja środowisk, tokenizacja i kontrole bezpieczeństwa są częścią architektury produktu i ograniczają zbędną ekspozycję danych wrażliwych.

01Wydzielone dane uwierzytelniające

Oddziel rozwój, testy i produkcję danymi uwierzytelniającymi odpowiednimi dla każdego środowiska.

02Tokenizacja

Ogranicz obieg danych wrażliwych w ścieżkach ponownych zakupów, płatności cyklicznych i one-click.

03PCI DSS 4.0.1

Kontrole bezpieczeństwa i ochrona środowiska płatniczego stosowane w infrastrukturze IOPAY.

04Zdarzenia i identyfikowalność

Używaj identyfikatorów, statusów i webhooków, aby śledzić cykl transakcji i reagować na wyjątki.

Przypadki użycia

Architektura dla różnych
modeli biznesowych.

Developer Platform IOPAY została zaprojektowana dla produktów, które muszą wbudować płatności we własne doświadczenie, od e-commerce po SaaS, marketplace, ERP i sprzedaż wspomaganą.

E-commerce

Własny checkout.

Kontroluj doświadczenie kupującego, podczas gdy IOPAY obsługuje warstwę płatności i zdarzeń.

Zobacz e-commerce →
SaaS & płatności cykliczne

Ponowne zakupy i ciągłe rozliczanie.

Łącz tokenizację, customers, zdarzenia i logikę swojej aplikacji dla ścieżek cyklicznych.

Zobacz dokumentację →
Marketplace'y

Sellerzy i Split płatności.

Przenieś kontekst Sellerów i reguły Split płatności do przepływu transakcji.

Zobacz marketplace'y →
ERP & finanse

Płatności połączone z operacjami.

Integruj płatności i zdarzenia z wewnętrznymi procesami uzgadniania rozliczeń, obsługi i finansów.

Porozmawiaj z ekspertem →
Inside sales

Płatność w lejku.

Generuj linki lub transakcje z CRM i zwracaj status do sprzedaży, onboardingu i finansów.

Zobacz linki →
White-label

Infrastruktura pod Twoim doświadczeniem.

Łącz API i zasoby platformy, aby oferować ścieżki płatności zintegrowane z Twoją marką.

Zobacz white-label →
Integracja i API IO

Od pierwszego wywołania do produkcji. Skorzystaj z najlepszej architektury rozwiązań płatniczych

Poznaj dokumentację, przetestuj integrację i wprowadź płatności do swojego produktu dzięki infrastrukturze IOPAY.