One API for the full link lifecycle.
V2 lets you create, get, update, delete and list Payment Links, as well as query the transactions originated by those links.
Items, Order Bump and identity.
Configure items, optional offers, primary color and banner when needed.
Installments, interest and usage.
Define installments, interest pass-through, availability window and maximum number of payments.
Queryable links and transactions.
List charges and filter the generated transactions by status, method, period and link.
Create a Payment Link
The items[*].amount and order_bump_items[*].amount values are given in cents. The main amount is calculated as the sum of the items; Order Bumps are not included in the initial amount.
Consider BASE_URL = https://api.iopay.com.br/api in the examples below.
{
"title": "Order #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 allowed for the authenticated account. debit is not available for Payment Links.V2 features
| Feature | Main fields | Use |
|---|---|---|
| Items | items[] | Products that make up the link's initial amount. |
| Order Bump | order_bump_items[] | Optional items offered at checkout. |
| Methods | enabled_payment_methods | Credit, Pix and boleto according to the account's enablement. |
| Installments | max_installment · highlight_installment_condition | From 1 to 12 installments, respecting the account setup. |
| Interest | pass_interest_to_customer · customer_interest_starts_at_installment | Control of interest pass-through to the buyer. |
| Availability | open_at · end_at · max_payments | Link window and usage limit. |
| Identity | primary_color · banners | Primary color and optional checkout banner. |
| Split | split_rules[] | Percentage or fixed distribution for enabled accounts. |
Creation with visual identity
To send a banner, use multipart/form-data on the same creation endpoint. Use only banners[left] or banners[right].
JPEG · PNG · WebP
Formats accepted for creation with banner.
Up to 5 MB.
Maximum dimensions of 4096×4096 and up to 16 MP.
Automatic boundary.
Don't set the Content-Type manually when using multipart in Postman.
Endpoints
| Method | Route | Operation |
|---|---|---|
| POST | /v2/payment_link | Create link in JSON. |
| POST | /v2/payment_link | Create link with banner via multipart. |
| GET | /v2/payment_link/{ID_LINK} | Get a link. |
| PATCH | /v2/payment_link/{ID_LINK} | Partially update. |
| DELETE | /v2/payment_link/{ID_LINK} | Delete a link. |
| GET | /v2/payment_link/list | List links with filters and pagination. |
| GET | /v2/payment_link/list/transactions | List transactions originated by links. |
Operational listings
Filter the charge base.
page, limit, offset, sort, status and creation range via date_range.
Find the right payment.
Besides pagination and period, filter by id_link, status and payment_type.
order_bump_items: [] removes the Order Bumps; split_rules: [] removes the split rules; primary_color: null restores the default theme.V2 for new integrations. V1 for compatibility.
Developer Central highlights V2 as the current reference. Existing integrations that still depend on the previous contract can continue to consult the public V1 documentation.