An API for the full link cycle.
V2 allows you to create, view, update, delete and list Payment Links, and to view transactions originating from these links.
Items, Order Bump and identity.
Set up items, optional offers, primary color and banner when necessary.
Parcel, interest and use.
Set installments, interest rate transfers, availability window and maximum payment amount.
Links and consultable transactions.
List bills and filter the transactions generated by status, method, period and link.
Creating a Payment Link
The values of items[*].amount and order_bump_items[*].amount They're informed in cents The main value is calculated by the sum of the items; Order Bumps do not enter the starting value
{
"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 and boleto. At least one method must be enabled and also released to the authenticated account. debit is not available for Payment Links.V2 resources
| The Court of Justice | Main fields | Use |
|---|---|---|
| Other articles | items[] | Products that make up the initial value of the link. |
| Order Bump | order_bump_items[] | Optional items offered at the checkout. |
| Methods | enabled_payment_methods | Credit, Pix and boleto as authorized by the account. |
| Installments | max_installment · highlight_installment_condition | 1 to 12 parcels, depending on the account setting. |
| Interest rates | pass_interest_to_customer · customer_interest_starts_at_installment | Control of the transfer of interest to the buyer. |
| Availability | open_at · end_at · max_payments | Link window and limit of use. |
| Identity | primary_color · banners | Main color and optional banner from the checkout. |
| Split | split_rules[] | Percentage or fixed distribution for enabled accounts. |
Creation with visual identity
To send banner, use multipart/form-data At the same endpoint of creation. Use only banners[left] or banners[right].
JPEG · PNG · WebP
Formats accepted by the banner creator.
Up to 5 MB.
Maximum size of 4096×4096 and up to 16 MP.
The automatic boundary.
Do not manually define Content-Type when using multipart in Postman.
Endpoints
| Method | Routes | Operations |
|---|---|---|
| POST | /v2/payment_link | Create a JSON link. |
| POST | /v2/payment_link | Create a banner link via multipart. |
| GET | /v2/payment_link/{ID_LINK} | Check out a link. |
| PATCH | /v2/payment_link/{ID_LINK} | Partially updated. |
| DELETE | /v2/payment_link/{ID_LINK} | Excluding a link. |
| GET | /v2/payment_link/list | List links with filters and pageings. |
| GET | /v2/payment_link/list/transactions | List transactions originating from links. |
Operational listings
Filter the billing base.
page, limit, offset, sort, status and breeding interval by date_range.
Find the right payment.
In addition to page and period, filter by id_link, status and payment_type.
order_bump_items: [] remove the Order Bumps; split_rules: [] removes the split rules; primary_color: null Restores the default theme.V2 for new integrations. V1 for compatibility.
Central Developer highlights V2 as a current reference. Existing integrations still dependent on the previous contract can continue to consult the public documentation of V1.