Yksi API linkin koko elinkaarelle.
V2:lla voit luoda, hakea, päivittää, poistaa ja listata maksulinkkejä sekä hakea näiden linkkien synnyttämät tapahtumat.
Tuotteet, Order Bump ja identiteetti.
Määritä tuotteet, valinnaiset tarjoukset, pääväri ja tarvittaessa banneri.
Erät, korot ja käyttö.
Määritä erät, korkojen siirto, saatavuusikkuna ja maksujen enimmäismäärä.
Haettavat linkit ja tapahtumat.
Listaa veloitukset ja suodata syntyneet tapahtumat tilan, maksutavan, ajanjakson ja linkin mukaan.
Luo maksulinkki
Arvot items[*].amount ja order_bump_items[*].amount annetaan senteissä. Pääsumma lasketaan tuotteiden summana; Order Bumpit eivät sisälly alkusummaan.
Oleta alla olevissa esimerkeissä BASE_URL = https://api.iopay.com.br/api.
{
"title": "Tilaus #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. Vähintään yhden maksutavan on oltava käytössä ja sallittu todennetulle tilille. debit ei ole käytettävissä maksulinkeissä.V2:n ominaisuudet
| Ominaisuus | Pääkentät | Käyttö |
|---|---|---|
| Tuotteet | items[] | Tuotteet, jotka muodostavat linkin alkusumman. |
| Order Bump | order_bump_items[] | Checkoutissa tarjottavat valinnaiset tuotteet. |
| Maksutavat | enabled_payment_methods | Luotto, Pix ja boleto tilin käyttöönoton mukaan. |
| Erämaksu | max_installment · highlight_installment_condition | 1–12 erää tilin määrityksen mukaisesti. |
| Korot | pass_interest_to_customer · customer_interest_starts_at_installment | Korkojen ostajalle siirron hallinta. |
| Saatavuus | open_at · end_at · max_payments | Linkin aikaikkuna ja käyttöraja. |
| Identiteetti | primary_color · banners | Pääväri ja valinnainen checkout-banneri. |
| Split | split_rules[] | Prosentti- tai kiinteä jako käyttöön otetuille tileille. |
Luonti visuaalisella identiteetillä
Lähetä banneri käyttämällä multipart/form-data-muotoa samassa luontipäätepisteessä. Käytä vain banners[left] tai banners[right].
JPEG · PNG · WebP
Bannerillisessa luonnissa hyväksytyt muodot.
Enintään 5 MB.
Enimmäiskoko 4096×4096 ja enintään 16 MP.
Automaattinen boundary.
Älä aseta Content-Typeä manuaalisesti käyttäessäsi multipartia Postmanissa.
Päätepisteet
| Maksutapa | Reitti | Toiminta |
|---|---|---|
| POST | /v2/payment_link | Luo linkki JSON-muodossa. |
| POST | /v2/payment_link | Luo linkki bannerilla multipartin kautta. |
| GET | /v2/payment_link/{ID_LINK} | Hae linkki. |
| PATCH | /v2/payment_link/{ID_LINK} | Päivitä osittain. |
| DELETE | /v2/payment_link/{ID_LINK} | Poista linkki. |
| GET | /v2/payment_link/list | Listaa linkit suodattimilla ja sivutuksella. |
| GET | /v2/payment_link/list/transactions | Listaa linkeistä syntyneet tapahtumat. |
Toiminnalliset listaukset
Suodata veloitusten joukkoa.
page, limit, offset, sort, status ja luontiväli date_range-parametrilla.
Löydä oikea maksu.
Sivutuksen ja ajanjakson lisäksi suodata id_link-, status- ja payment_type-arvoilla.
order_bump_items: [] poistaa Order Bumpit; split_rules: [] poistaa split-säännöt; primary_color: null palauttaa oletusteeman.V2 uusiin integraatioihin. V1 yhteensopivuuteen.
Developer Central korostaa V2:ta nykyisenä referenssinä. Olemassa olevat integraatiot, jotka riippuvat vielä aiemmasta sopimuksesta, voivat edelleen käyttää V1:n julkista dokumentaatiota.