Eine API für den gesamten Linkzyklus.
V2 ermöglicht es, Zahlungslinks zu erstellen, zu verfolgen, zu aktualisieren, zu löschen und zu listen, sowie die Transaktionen zu verfolgen, die durch diese Links entstanden sind.
Gegenstände, Order Bump und Identität.
Setzen Sie es auf, Optionsangebote, Hauptfarbe und Banner zu setzen, wenn nötig.
Vermögen, Zinsen und Nutzung.
Stellen Sie Pläne fest, übertragen Sie Zins, verfügbare Fenster und maximale Zahlungsrate.
Links und vernehmbare Transaktionen.
Listen Sie Abrechnungen auf und filtern Sie die Transaktionen, die Sie erzeugt haben, nach Status, Methode, Periode und Link.
Erstellen Sie einen Zahlungslink
Die Werte von items[*].amount und order_bump_items[*].amount Sie sind in Cent informiert Der Hauptwert wird durch die Summe der Artikel berechnet; Order Bumps gehen nicht in den Startwert ein
{
"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 und boleto. Mindestens eine Methode muss aktiviert und auch für das authentifizierte Konto freigegeben werden. debit ist nicht für Zahlungslinks verfügbar.V2-Ressourcen
| Anspruch | Hauptfelder | Verwendung |
|---|---|---|
| Gegenstände | items[] | Produkte, die den Anfangswert des Links bilden. |
| Order Bump | order_bump_items[] | Optional erhältliche Gegenstände, die bei der Kasse angeboten werden. |
| Methoden | enabled_payment_methods | Kredit, Pix und boleto nach dem Aktenzahlen. |
| Ratenzahlung | max_installment · highlight_installment_condition | Von 1 bis 12 Plätzen, wobei die Konto-Einstellung berücksichtigt wird. |
| Zinsen | pass_interest_to_customer · customer_interest_starts_at_installment | Überprüfung der Zinsüberweisung an den Käufer. |
| Verfügbarkeit | open_at · end_at · max_payments | Linkfenster und Einsatzgrenze. |
| Identität | primary_color · banners | Hauptfarbe und optionales Banner aus dem Scheck. |
| Split | split_rules[] | Prozentsatz oder Festverteilung für berechtigte Konten. |
Schaffung mit visueller Identität
Wenn Sie Banner senden, verwenden Sie multipart/form-data an demselben Kreationsendpunkt. Nur verwenden banners[left] oder banners[right].
JPEG · PNG · WebP
Format, die von der Schaffung mit Banner akzeptiert werden.
Bis zu 5 MB.
Höchstgröße 4096x4096 und bis zu 16 MP.
Automatische Grenze.
Sie müssen den Content-Type nicht manuell definieren, wenn Sie Multipart in Postman verwenden.
Endpunkte
| Methode | Route | Betrieb |
|---|---|---|
| POST | /v2/payment_link | Link in JSON zu erstellen. |
| POST | /v2/payment_link | Link mit Banner über Multipart zu erstellen. |
| GET | /v2/payment_link/{ID_LINK} | - Sieh dir einen Link an. |
| PATCH | /v2/payment_link/{ID_LINK} | - Teil-Aktualisierung. |
| DELETE | /v2/payment_link/{ID_LINK} | Ein Link ausschließen. |
| GET | /v2/payment_link/list | Liste von Links mit Filtern und Paging. |
| GET | /v2/payment_link/list/transactions | Listen Sie Transaktionen, die durch Links entstanden sind. |
Betriebslisten
Filtern Sie die Gebührenbasis.
page, limit, offset, sort, status und Zuchtzeit durch date_range.
Finden Sie die richtige Zahlung.
Filtern Sie neben Paging und Periode id_link, status und payment_type.
order_bump_items: [] die Order Bumps entfernen; split_rules: [] die Split-Regelungen entfernt; primary_color: null Wiederherstellen Sie das Standardthema.V2 für neue Integrationen. V1 für Kompatibilität.
Die Entwicklerzentralen legen V2 als aktuelles Referenzfeld hervor. Bestehende Integrationen, die noch vom vorherigen Vertrag abhängen, können weiter in der öffentlichen Dokumentation von V1 eingesehen werden.