Una API para todo el ciclo del enlace.
La V2 permite crear, consultar, actualizar, eliminar y listar Enlaces de Pago, además de consultar las transacciones originadas por esos enlaces.
Artículos, Order Bump e identidad.
Configura artículos, ofertas opcionales, color principal y banner cuando sea necesario.
Cuotas, intereses y uso.
Define cuotas, traslado de intereses, ventana de disponibilidad y cantidad máxima de pagos.
Enlaces y transacciones consultables.
Lista cobros y filtra las transacciones generadas por estado, método, período y enlace.
Crear un Enlace de Pago
Los valores de items[*].amount y order_bump_items[*].amount se indican en centavos. El valor principal se calcula como la suma de los artículos; los Order Bumps no entran en el valor inicial.
Considera BASE_URL = https://api.iopay.com.br/api en los ejemplos siguientes.
{
"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 y boleto. Al menos un método debe estar habilitado y también permitido para la cuenta autenticada. debit no está disponible para Enlaces de Pago.Recursos de la V2
| Recurso | Campos principales | Uso |
|---|---|---|
| Artículos | items[] | Productos que componen el valor inicial del enlace. |
| Order Bump | order_bump_items[] | Artículos opcionales ofrecidos en el checkout. |
| Métodos | enabled_payment_methods | Crédito, Pix y boleto según la habilitación de la cuenta. |
| Pago a plazos | max_installment · highlight_installment_condition | De 1 a 12 cuotas, respetando la configuración de la cuenta. |
| Intereses | pass_interest_to_customer · customer_interest_starts_at_installment | Control del traslado de intereses al comprador. |
| Disponibilidad | open_at · end_at · max_payments | Ventana del enlace y límite de usos. |
| Identidad | primary_color · banners | Color principal y banner opcional del checkout. |
| Split | split_rules[] | Distribución porcentual o fija para cuentas habilitadas. |
Creación con identidad visual
Para enviar un banner, usa multipart/form-data en el mismo endpoint de creación. Utiliza solo banners[left] o banners[right].
JPEG · PNG · WebP
Formatos aceptados en la creación con banner.
Hasta 5 MB.
Dimensión máxima de 4096×4096 y hasta 16 MP.
Boundary automático.
No definas manualmente el Content-Type al usar multipart en Postman.
Endpoints
| Método | Ruta | Operación |
|---|---|---|
| POST | /v2/payment_link | Crear enlace en JSON. |
| POST | /v2/payment_link | Crear enlace con banner vía multipart. |
| GET | /v2/payment_link/{ID_LINK} | Consultar un enlace. |
| PATCH | /v2/payment_link/{ID_LINK} | Actualizar parcialmente. |
| DELETE | /v2/payment_link/{ID_LINK} | Eliminar un enlace. |
| GET | /v2/payment_link/list | Listar enlaces con filtros y paginación. |
| GET | /v2/payment_link/list/transactions | Listar transacciones originadas por enlaces. |
Listados operativos
Filtra la base de cobros.
page, limit, offset, sort, status e intervalo de creación mediante date_range.
Encuentra el pago correcto.
Además de la paginación y el período, filtra por id_link, status y payment_type.
order_bump_items: [] elimina los Order Bumps; split_rules: [] elimina las reglas de split; primary_color: null restaura el tema predeterminado.V2 para nuevas integraciones. V1 por compatibilidad.
Developer Central destaca la V2 como referencia actual. Las integraciones existentes que aún dependen del contrato anterior pueden seguir consultando la documentación pública de la V1.