Uma API para o ciclo completo do link.
A V2 permite criar, consultar, atualizar, excluir e listar Links de Pagamento, além de consultar as transações originadas por esses links.
Itens, Order Bump e identidade.
Configure itens, ofertas opcionais, cor principal e banner quando necessário.
Parcelamento, juros e uso.
Defina parcelas, repasse de juros, janela de disponibilidade e quantidade máxima de pagamentos.
Links e transações consultáveis.
Liste cobranças e filtre as transações geradas por status, método, período e link.
Criar um Link de Pagamento
Os valores de items[*].amount e order_bump_items[*].amount são informados em centavos. O valor principal é calculado pela soma dos itens; Order Bumps não entram no valor inicial.
Considere BASE_URL = https://api.iopay.com.br/api nos exemplos abaixo.
{
"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 e boleto. Pelo menos um método precisa estar habilitado e também liberado para a conta autenticada. debit não está disponível para Links de Pagamento.Recursos da V2
| Recurso | Campos principais | Uso |
|---|---|---|
| Itens | items[] | Produtos que compõem o valor inicial do link. |
| Order Bump | order_bump_items[] | Itens opcionais oferecidos no checkout. |
| Métodos | enabled_payment_methods | Crédito, Pix e boleto conforme habilitação da conta. |
| Parcelamento | max_installment · highlight_installment_condition | De 1 a 12 parcelas, respeitando a configuração da conta. |
| Juros | pass_interest_to_customer · customer_interest_starts_at_installment | Controle do repasse de juros ao comprador. |
| Disponibilidade | open_at · end_at · max_payments | Janela do link e limite de utilizações. |
| Identidade | primary_color · banners | Cor principal e banner opcional do checkout. |
| Split | split_rules[] | Distribuição percentual ou fixa para contas habilitadas. |
Criação com identidade visual
Para enviar banner, use multipart/form-data no mesmo endpoint de criação. Utilize apenas banners[left] ou banners[right].
JPEG · PNG · WebP
Formatos aceitos pela criação com banner.
Até 5 MB.
Dimensão máxima de 4096×4096 e até 16 MP.
Boundary automático.
Não defina manualmente o Content-Type ao usar multipart no Postman.
Endpoints
| Método | Rota | Operação |
|---|---|---|
| POST | /v2/payment_link | Criar link em JSON. |
| POST | /v2/payment_link | Criar link com banner via multipart. |
| GET | /v2/payment_link/{ID_LINK} | Consultar um link. |
| PATCH | /v2/payment_link/{ID_LINK} | Atualizar parcialmente. |
| DELETE | /v2/payment_link/{ID_LINK} | Excluir um link. |
| GET | /v2/payment_link/list | Listar links com filtros e paginação. |
| GET | /v2/payment_link/list/transactions | Listar transações originadas por links. |
Listagens operacionais
Filtre a base de cobranças.
page, limit, offset, sort, status e intervalo de criação por date_range.
Encontre o pagamento certo.
Além da paginação e período, filtre por id_link, status e payment_type.
order_bump_items: [] remove os Order Bumps; split_rules: [] remove as regras de split; primary_color: null restaura o tema padrão.V2 para novas integrações. V1 para compatibilidade.
A Developer Central destaca a V2 como referência atual. Integrações existentes que ainda dependem do contrato anterior podem continuar consultando a documentação pública da V1.