API koko lenkkisykliä varten.
V2:n avulla voit luoda, tarkastella, päivittää, poistaa ja listata Maksulinkit:n ja tarkastella näistä linkeistä peräisin olevia tapahtumia.
Tavarat, Tilaa Bump ja identiteetti.
Aseta kohteita, valinnaisia tarjouksia, primääriväriä ja banneria tarvittaessa.
Parcel, kiinnostus ja käyttö.
Aseta erät, koronsiirrot, saatavuusikkuna ja maksimimaksu.
Linkkejä ja konsultoitavia liiketoimia.
Luettele laskut ja suodata statuksen, menetelmän, jakson ja linkin aiheuttamat tapahtumat.
Maksulinkin luominen
Arvot: items[*].amount ja order_bump_items[*].amount Heille tiedotetaan sentteinä Pääarvo lasketaan erien summan mukaan; Tilaukset eivät anna lähtöarvoa
{
"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 ja boleto. Ainakin yksi menetelmä on otettava käyttöön ja myös luovutettava oikeaksi todistetulle tilille. debit Maksulinkit-valmistetta ei ole saatavilla.V2-resurssit
| Yhteisöjen tuomioistuin | Pääkentät | Käyttö |
|---|---|---|
| Muut tavarat | items[] | Tuotteet, jotka muodostavat linkin alkuperäisen arvon. |
| Tilausbump | order_bump_items[] | Valinnaiset tuotteet, joita tarjotaan kassalla. |
| Menetelmät | enabled_payment_methods | Tilin valtuuttamat luotot, Pix ja boleto. |
| Osamaksut | max_installment · highlight_installment_condition | 1–12 pakettia tilin asettelusta riippuen. |
| Korot | pass_interest_to_customer · customer_interest_starts_at_installment | Koronsiirron valvonta ostajalle. |
| Käytettävyys | open_at · end_at · max_payments | Linkki ikkunaan ja käyttörajaan. |
| Identiteetti | primary_color · banners | Pääväri ja valinnainen banneri kassalta. |
| Split | split_rules[] | Prosenttiosuus tai kiinteä jakelu käytössä oleville tileille. |
Luominen visuaalisella identiteetillä
Lähetä banneri lähettämällä multipart/form-data Samalla päätepisteellä kuin luominen. Käytä vain banners[left] tai banners[right].
JPEG · PNG · WebP
Bannerin luojan hyväksymät muodot.
Korkeintaan 5 Mt.
Enimmäiskoko 4096×4096 ja enintään 16 MP.
Automaattinen raja.
Älä määritä sisältöä käsin, kun käytät Postman:n moniosaisuutta.
Loppupisteet
| Menetelmä | Reitit | Toiminta |
|---|---|---|
| POST | /v2/payment_link | Luo JSON-linkki. |
| POST | /v2/payment_link | Luo bannerilinkki moniosaisen kautta. |
| GET | /v2/payment_link/{ID_LINK} | Katso linkkiä. |
| PATCH | /v2/payment_link/{ID_LINK} | Osittain päivitetty. |
| DELETE | /v2/payment_link/{ID_LINK} | Linkkiä lukuun ottamatta. |
| GET | /v2/payment_link/list | Luettele linkit suodattimiin ja hakuihin. |
| GET | /v2/payment_link/list/transactions | Luettelo linkeistä peräisin olevista liiketoimista. |
Operatiivinen listautuminen
Suodata laskutuspohja.
page, limit, offset, sort, status ja siitosväli date_range.
Etsi oikea maksu.
Sivun ja ajanjakson lisäksi suodata id_link, status ja payment_type.
order_bump_items: [] Poista tilausbumpit; split_rules: [] poistaa jakosäännöt; primary_color: null Palauttaa oletusteeman.V2 uusien integraatioiden varalle. V1 yhteensopivuutta varten.
Keskuskehittäjä nostaa V2:n ajankohtaiseksi referenssiksi. Nykyiset, aiemmasta sopimuksesta riippuvat integraatiot voivat edelleen tutustua V1:n julkisiin asiakirjoihin.