ItemsCrear ítem

Crear ítem

POSThttps://api.copayex.com/api/v1/items

Crea un ítem pagable con el monto total y metadatos opcionales.

Parámetros de solicitud

CampoTipoUbicaciónRequeridoDescripción
amountnumberBody (JSON)Importe total del ítem.
titlestringBody (JSON)Nombre visible del ítem.
descriptionstringBody (JSON)NoDescripción opcional.
staticQrIdstringBody (JSON)NoIdentificador de QR estático previamente generado.
paymentMethodsstring[]Body (JSON)NoLista de métodos habilitados (usa los codes oficiales).

Parámetros de respuesta

CampoTipoDescripción
idnumberIdentificador interno único del ítem en Copayex.
numbernumberConsecutivo sugerido para búsquedas en el frontend (se consulta por este número).
uuidstringIdentificador global del ítem; puede usarse como referencia externa.
amountnumberPrecio total configurado para el ítem.
amountPayednumberMonto acumulado que ya se pagó sobre el ítem.
titlestringTítulo visible del ítem (ej. “Combo latte”).
descriptionstringDescripción complementaria (ej. “cafe + medialunas”).
status"active" | "finished" | "void"Estado actual del ciclo de vida del ítem.
staticQrstring | nullSi es null, el ítem no tiene QR asociado; de lo contrario, devuelve el ID del QR estático vinculado.
paymentMethodsstring[]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"
}