API do całego cyklu łączenia.
V2 umożliwia tworzenie, przeglądanie, aktualizację, usunięcie i listę Linki do Płatności, a także przeglądanie transakcji wynikających z tych linków.
Towarzystwo, Order Bump i tożsamość.
Ustaw przedmioty, oferty opcjonalne, główny kolor i banner, gdy to konieczne.
Wydatki, odsetki i użytkowanie.
Ustaw parę, przepływ procentowy, okno dostępności i maksymalną kwotę płatności.
Linki i transakcje, które można było przejrzeć.
Wylicz opłaty i filtraj transakcje generowane według statusu, metody, okresu i linku.
Utworzenie linku płatniczego
Wartości items[*].amount i order_bump_items[*].amount są informowane w centach. Wartość główna jest obliczana przez sumę przedmiotów; Order Bumps nie wchodzi w wartość początkową.
{
"title": "Pedido #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. Przynajmniej jedna z metod musi być włączona i również uwolniona do uwierzytelnionej rachunku. debit nie jest dostępna dla linków płatności.Węgiel i węgiel
| Wniosek | Główne pola | Użycie |
|---|---|---|
| Wykorzystywane w postaci sztucznych | items[] | Produkty stanowiące początkową wartość linku. |
| Rozkaz Bump | order_bump_items[] | Opcjonalne przedmioty oferowane w kasie. |
| Metody | enabled_payment_methods | Kredyt Pix i boleto w zależności od uprawnienia rachunku. |
| Raty | max_installment · highlight_installment_condition | Od 1 do 12 kawałków, przy uwzględnieniu ustawień konta. |
| Wpływy | pass_interest_to_customer · customer_interest_starts_at_installment | Kontrola przelewu odsetek do kupującego. |
| Dostępność | open_at · end_at · max_payments | Okno linku i limit użytkowania. |
| Tożsamość | primary_color · banners | Kolor główny i opcjonalny banner z kasy. |
| Split | split_rules[] | Wypłaty procentowe lub stałe do kont uprawnionych. |
Stworzenie identyfikacji wizualnej
Do wysyłania banerów użyj multipart/form-data w tym samym punktie tworzenia. Używaj tylko banners[left] lub banners[right].
JPEG · PNG · WebP
Formaty akceptowane przez twórców z banerami.
Do 5 MB.
Maksymalny rozmiar 4096×4096 i do 16 MP.
Automatyczna granica.
Nie należy ręcznie zdefiniować Content-Type przy użyciu multipart w Postman.
Wykres
| Metoda | Wykładnik | Operacje |
|---|---|---|
| POST | /v2/payment_link | Tworzenie łącza w JSON. |
| POST | /v2/payment_link | Tworzenie linku bannerów za pośrednictwem multipart. |
| GET | /v2/payment_link/{ID_LINK} | Sprawdź link. |
| PATCH | /v2/payment_link/{ID_LINK} | Częściowo aktualizuję. |
| DELETE | /v2/payment_link/{ID_LINK} | Wyłączyć link. |
| GET | /v2/payment_link/list | Wyliczanie linków filtrowanych i stron. |
| GET | /v2/payment_link/list/transactions | Wyliczanie transakcji pochodzących z linków. |
Lista operacyjna
Filtruj bazę opłat.
page, limit, offset, sort, status i odstęp hodowli przez date_range.
Znajdź odpowiednią opłatę.
Oprócz stron i okresu, filtrować przez id_link, status i payment_type.
order_bump_items: [] usuwanie Order Bumps; split_rules: [] usuwa zasady split; primary_color: null przywracają domyślny temat.V2 do nowych integracji. V1 do kompatybilności.
Developer Central podkreśla, że V2 jest obecnym punktem odniesienia. Istniejące integracje, które nadal są uzależnione od poprzedniej umowy, mogą kontynuować przegląd publicznej dokumentacji V1.