Crear ítem
POST
https://api.copayex.com/api/v1/itemsCrea un ítem pagable con el monto total y metadatos opcionales.
Parámetros de solicitud
| Campo | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
amount | number | Body (JSON) | Sí | Importe total del ítem. |
title | string | Body (JSON) | Sí | Nombre visible del ítem. |
description | string | Body (JSON) | No | Descripción opcional. |
staticQrId | string | Body (JSON) | No | Identificador de QR estático previamente generado. |
paymentMethods | string[] | Body (JSON) | No | Lista de métodos habilitados (usa los codes oficiales). |
Parámetros de respuesta
| Campo | Tipo | Descripción |
|---|---|---|
id | number | Identificador interno único del ítem en Copayex. |
number | number | Consecutivo sugerido para búsquedas en el frontend (se consulta por este número). |
uuid | string | Identificador global del ítem; puede usarse como referencia externa. |
amount | number | Precio total configurado para el ítem. |
amountPayed | number | Monto acumulado que ya se pagó sobre el ítem. |
title | string | Título visible del ítem (ej. “Combo latte”). |
description | string | Descripción complementaria (ej. “cafe + medialunas”). |
status | "active" | "finished" | "void" | Estado actual del ciclo de vida del ítem. |
staticQr | string | null | Si es null, el ítem no tiene QR asociado; de lo contrario, devuelve el ID del QR estático vinculado. |
paymentMethods | string[] | Métodos de pago habilitados; por el momento solo "mercadopago". |
Ejemplos de solicitud
curl -X POST "https://api.copayex.com/api/v1/items" \
-H "Authorization: Bearer <client_access_token>" \
-H "Content-Type: application/json" \
-d '{
"amount": 1200,
"title": "Combo latte",
"description": "Café + medialunas",
"paymentMethods": ["mercadopago"]
}'Respuesta de ejemplo
{
"uuid": "f9c31c31-285e-4a5d-8ebd-c6598eb3be4e",
"amount": 1200,
"amountPayed": 0,
"title": "Combo latte",
"description": "Café + medialunas",
"status": "active",
"staticQr": null,
"paymentMethods": ["mercadopago"],
"number": 1,
"createdAt": "2025-11-10T15:47:46.000Z"
}