Jedno API dla pełnego cyklu linku.
V2 pozwala tworzyć, pobierać, aktualizować, usuwać i wyświetlać Linki do płatności, a także sprawdzać transakcje pochodzące z tych linków.
Pozycje, Order Bump i tożsamość.
Skonfiguruj pozycje, oferty opcjonalne, kolor główny i banner, gdy to potrzebne.
Raty, odsetki i użycie.
Określ raty, przeniesienie odsetek, okno dostępności i maksymalną liczbę płatności.
Linki i transakcje dostępne do wyszukiwania.
Wyświetlaj płatności i filtruj wygenerowane transakcje według statusu, metody, okresu i linku.
Utwórz Link do płatności
Wartości items[*].amount i order_bump_items[*].amount podaje się w centach. Kwota główna jest sumą pozycji; Order Bumpy nie wchodzą do kwoty początkowej.
W poniższych przykładach przyjmij BASE_URL = https://api.iopay.com.br/api.
{
"title": "Zamówienie #1001",
"description": "Compra de produtos diversos",
"status": "enabled",
"open_at": null,
"end_at": null,
"max_payments": 1,
"max_installment": 3,
"highlight_installment_condition": true,
"enabled_payment_methods": {
"credit": true,
"pix": true,
"boleto": true
},
"pass_interest_to_customer": true,
"customer_interest_starts_at_installment": 1,
"primary_color": "4099b4",
"items": [
{
"name": "Produto principal",
"amount": 60000
}
],
"order_bump_items": [
{
"name": "Garantia estendida",
"amount": 15000
}
]
}credit, pix i boleto. Co najmniej jedna metoda musi być włączona i dozwolona dla uwierzytelnionego konta. debit nie jest dostępny dla Linków do płatności.Funkcje V2
| Funkcja | Główne pola | Zastosowanie |
|---|---|---|
| Pozycje | items[] | Produkty tworzące kwotę początkową linku. |
| Order Bump | order_bump_items[] | Opcjonalne pozycje oferowane w checkoucie. |
| Metody | enabled_payment_methods | Kredyt, Pix i boleto zgodnie z włączeniem konta. |
| Raty | max_installment · highlight_installment_condition | Od 1 do 12 rat, zgodnie z konfiguracją konta. |
| Odsetki | pass_interest_to_customer · customer_interest_starts_at_installment | Kontrola przeniesienia odsetek na kupującego. |
| Dostępność | open_at · end_at · max_payments | Okno linku i limit użyć. |
| Tożsamość | primary_color · banners | Kolor główny i opcjonalny banner checkoutu. |
| Split | split_rules[] | Podział procentowy lub stały dla włączonych kont. |
Tworzenie z tożsamością wizualną
Aby wysłać banner, użyj multipart/form-data w tym samym endpoincie tworzenia. Używaj tylko banners[left] lub banners[right].
JPEG · PNG · WebP
Formaty akceptowane przy tworzeniu z bannerem.
Do 5 MB.
Maksymalny wymiar 4096×4096 i do 16 MP.
Automatyczny boundary.
Nie ustawiaj ręcznie Content-Type, używając multipart w Postmanie.
Endpointy
| Metoda | Ścieżka | Operacje |
|---|---|---|
| POST | /v2/payment_link | Utwórz link w JSON. |
| POST | /v2/payment_link | Utwórz link z bannerem przez multipart. |
| GET | /v2/payment_link/{ID_LINK} | Pobierz link. |
| PATCH | /v2/payment_link/{ID_LINK} | Zaktualizuj częściowo. |
| DELETE | /v2/payment_link/{ID_LINK} | Usuń link. |
| GET | /v2/payment_link/list | Wyświetl linki z filtrami i paginacją. |
| GET | /v2/payment_link/list/transactions | Wyświetl transakcje pochodzące z linków. |
Listy operacyjne
Filtruj bazę płatności.
page, limit, offset, sort, status i przedział utworzenia przez date_range.
Znajdź właściwą płatność.
Poza paginacją i okresem filtruj według id_link, status i payment_type.
order_bump_items: [] usuwa Order Bumpy; split_rules: [] usuwa reguły splitu; primary_color: null przywraca domyślny motyw.V2 dla nowych integracji. V1 dla zgodności.
Developer Central wyróżnia V2 jako aktualną referencję. Istniejące integracje zależne od poprzedniego kontraktu mogą nadal korzystać z publicznej dokumentacji V1.