Üks API lüli täieliku tsükli jaoks.
V2 võimaldab luua, küsida, ajakohastada, kustutada ja loetleda Makselingid ning küsida neid linke põhjustatud tehinguid.
Asjad, Order Bump ja identiteet.
Konfigureerige vajadusel tooteid, valikut, peamist värvi ja bannerit.
Panking, intressid ja kasutamine.
Määrake osalejad, intressimäärad, kättesaadavus ja maksimaalne summa.
Linkid ja küsitatavad tehingud.
Loe üles maksed ja filtreeri tehingud, mis on tekitatud staatuse, meetodi, ajavahemiku ja linki järgi.
Loote makseküsimuse
Väärtused items[*].amount ja order_bump_items[*].amount Nad saavad selle eest raha. Peamine väärtus arvutatakse kaupade summast; Order Bumps ei kuulu algväärtuse hulka.
{
"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. Vähemalt üks meetod peab olema lubatud ja autentitud kontole vabastatud. debit ei ole kättesaadav makseküsimuste jaoks.V2 ressurssid
| Kohtumine | Peamised väljad | Kasuta |
|---|---|---|
| Itemid | items[] | Tooded, mis moodustavad võrgustiku algväärtust. |
| Order Bump | order_bump_items[] | Võimaluslike kaupade pakkumine kasumi juures. |
| Meetodid | enabled_payment_methods | Krediit Pix ja boleto kui konto loetlus on. |
| Osamaksed | max_installment · highlight_installment_condition | 1 kuni 12 osa, arvestades konto seadet. |
| Võitsed | pass_interest_to_customer · customer_interest_starts_at_installment | Kontrollige intressimäära üleandmist ostjale. |
| Lisaldusvõime | open_at · end_at · max_payments | Võrgu ja kasutamispiirang. |
| Identiteet | primary_color · banners | Peamine värv ja valikulised pankreedid. |
| Split | split_rules[] | % või fikseeritud jaotus volitatud kontodele. |
Visualne identiteediga loomine
Bannerite saatmiseks kasutage multipart/form-data sama loomingupunktis. Kasuta ainult banners[left] või banners[right].
JPEG · PNG · WebP
Banneriga loomise poolt vastuvõetavad vormid.
Kuni 5 MB.
Maksimaalne suurus 4096×4096 ja kuni 16 MP.
Automaatne piir.
Kui Postman puhul kasutatakse multipartit, ei ole vaja manuaalselt määratleda Content-Type'i.
Endpoints
| Meetod | Rot | Tegevus |
|---|---|---|
| POST | /v2/payment_link | JSON-s sideme loomine. |
| POST | /v2/payment_link | Looda banneride link multipart kaudu. |
| GET | /v2/payment_link/{ID_LINK} | Küsige linki. |
| PATCH | /v2/payment_link/{ID_LINK} | Osaliselt uuendatakse. |
| DELETE | /v2/payment_link/{ID_LINK} | Lülita link välja. |
| GET | /v2/payment_link/list | Seada filtreeritud sided ja pagineerimine. |
| GET | /v2/payment_link/list/transactions | Loetellu tehingud, mis pärinevad linkidest. |
Tegevuslistused
Filtreerima tasude baasi.
page, limit, offset, sort, status ja loominguaeg date_range.
Leia õige makse.
Üle lehekülje ja perioodi, filtreeri läbi id_link, status ja payment_type.
order_bump_items: [] Käida Order Bumps; split_rules: [] eetab split-reeglid primary_color: null taastab standardtema.V2 uute integreeringute jaoks. V1 koostalitlus.
Kesk-arendaja rõhutab, et V2 on praegune referent. V1 avalik-õiguslikest dokumentidest saavad olemasolevad integratsioonid, kes veel sõltuvad eelmisest lepingust, edasi vaadata.