Un API para el ciclo completo del enlace.
V2 permite crear, consultar, actualizar, eliminar y listar Enlaces de Pago, además de consultar las transacciones originadas por estos enlaces.
Los artículos, el orden Bump y la identidad.
Configure artículos, ofertas opcionales, color principal y banner cuando sea necesario.
Parcelación, intereses y uso.
Definir las parcelas, transferir intereses, ventana de disponibilidad y cantidad máxima de pagos.
Enlaces y transacciones consultables.
Enumera 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 informan en centavos El valor principal se calcula por la suma de los artículos; Order Bumps no entra en el valor inicial
{
"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 ser habilitado y también liberado 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. |
| Orden Bump | order_bump_items[] | Otros artículos ofrecidos en el checkout. |
| Métodos | enabled_payment_methods | Crédito, Pix y boleto según la calificación de la cuenta. |
| Cuotas | max_installment · highlight_installment_condition | De 1 a 12 parcelas, respetando la configuración de la cuenta. |
| Los intereses | pass_interest_to_customer · customer_interest_starts_at_installment | Control de la transferencia de intereses al comprador. |
| Disponibilidad | open_at · end_at · max_payments | Ventana de enlace y límite de uso. |
| Identidad | primary_color · banners | Color principal y banner opcional del checkout. |
| Split | split_rules[] | Distribución porcental o fija de las cuentas habilitadas. |
Creación con identidad visual
Para enviar banners, use multipart/form-data en el mismo punto de creación. Sólo use banners[left] o banners[right].
JPEG · PNG · WebP
Formatos aceptados por la creación con banner.
Hasta 5 MB.
Tamaño máximo de 4096×4096 y hasta 16 MP.
- Con un límite automático.
No defina manualmente el tipo de contenido al utilizar multipart en Postman.
Los puntos finales
| Método | Rutas | Operación |
|---|---|---|
| POST | /v2/payment_link | Crear enlaces en JSON. |
| POST | /v2/payment_link | Crear enlaces con banner a través de multipart. |
| GET | /v2/payment_link/{ID_LINK} | Consulte un enlace. |
| PATCH | /v2/payment_link/{ID_LINK} | Actualizar parcialmente. |
| DELETE | /v2/payment_link/{ID_LINK} | Excluir un enlace. |
| GET | /v2/payment_link/list | Enumerar enlaces con filtros y páginas. |
| GET | /v2/payment_link/list/transactions | Enumerar las transacciones originadas por enlaces. |
Listaje operativo
Filtrar la base de cobros.
page, limit, offset, sort, status y el intervalo de cría por date_range.
Encuentra el pago correcto.
Además de la página y el período, filtra por id_link, status y payment_type.
order_bump_items: [] eliminar los Order Bumps; split_rules: [] elimina las reglas de split; primary_color: null restaura el tema estándar.V2 para nuevas integraciones. V1 para compatibilidad.
El Desarrollador Central destaca a V2 como referencia actual. Las integraciones existentes que aún dependen del contrato anterior pueden seguir consultando la documentación pública de V1.