En API for hele forbindelsescyklussen.
V2 giver dig mulighed for at oprette, se, opdatere, slette og liste Betalingslinks, og at se transaktioner, der stammer fra disse links.
Elementer, Order Bump og identitet.
Opsætning af elementer, valgfrie tilbud, primær farve og banner når det er nødvendigt.
Parcel, renter og brug.
Sæt rater, renteoverførsler, tilgængelighedsvindue og maksimalt betalingsbeløb.
Links og konsulentforretninger.
Liste regninger og filter transaktioner genereret af status, metode, periode og link.
Oprettelse af et betalingslink
Værdierne af items[*].amount og order_bump_items[*].amount De er oplyst i cents Hovedværdien beregnes ved summen af de elementer; Order Pumper ikke indtaste startværdien
{
"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 og boleto. Mindst én metode skal være aktiveret og også frigivet til den bekræftede konto. debit er ikke tilgængelig for Betalingslinks.V2-midler
| Domstolen | Hovedfelter | Anvendelse |
|---|---|---|
| Andre varer | items[] | Produkter, der udgør den oprindelige værdi af linket. |
| Order Bump | order_bump_items[] | Valgfrie elementer, der tilbydes ved kassen. |
| Metoder | enabled_payment_methods | Kredit, Pix og boleto som godkendt af kontoen. |
| Ratebetaling | max_installment · highlight_installment_condition | 1 til 12 pakker, afhængigt af kontoindstillingen. |
| Rentesatser | pass_interest_to_customer · customer_interest_starts_at_installment | Kontrol med overførslen af renter til køberen. |
| Tilgængelighed | open_at · end_at · max_payments | Link vindue og anvendelsesgrænse. |
| Identitet | primary_color · banners | Hovedfarve og valgfrit banner fra kassen. |
| Split | split_rules[] | Procent eller fast fordeling for aktiverede konti. |
Skabelse med visuel identitet
For at sende banner, brug multipart/form-data Ved det samme endepunkt af skabelsen. Må kun anvendes banners[left] eller banners[right].
JPEG · PNG · WebP
Formater accepteret af bannerskaberen.
Op til 5 MB.
Maksimumstørrelse på 4096 × 4096 og op til 16 MP.
Den automatiske grænse.
Du må ikke manuelt definere content- Type, når du bruger multipart i Postman.
Slutpunkter
| Metode | Ruter | Drift |
|---|---|---|
| POST | /v2/payment_link | Opret et JSON link. |
| POST | /v2/payment_link | Opret et bannerlink via multipart. |
| GET | /v2/payment_link/{ID_LINK} | Tjek et link. |
| PATCH | /v2/payment_link/{ID_LINK} | Delvis opdateret. |
| DELETE | /v2/payment_link/{ID_LINK} | Ekskl. et link. |
| GET | /v2/payment_link/list | List links med filtre og sider. |
| GET | /v2/payment_link/list/transactions | Liste over transaktioner, der stammer fra links. |
Operationelle fortegnelser
Filtrér faktureringsbasen.
page, limit, offset, sort, status og avlsinterval ved date_range.
Find den rigtige betaling.
Ud over side og periode, filter med id_link, status og payment_type.
order_bump_items: [] fjerne ordrepumper; split_rules: [] fjerner reglerne om opdeling primary_color: null Gendanner standardtemaet.V2 for nye integreringer. V1 for kompatibilitet.
Central udvikler fremhæver V2 som en aktuel reference. Eksisterende integreringer, der stadig er afhængige af den tidligere kontrakt, kan fortsat konsultere den offentlige dokumentation for V1.