Crear checkouts

​

Panel

1. Abrí Checkouts en la barra lateral (/app/checkouts).
2. Revisá la fila de estadísticas y las sesiones recientes en el resumen.
3. En Crear checkout, elegí país, cuenta (opcional — HG.Cash elige una cuenta operativa elegible si no indicás una), monto y URL de éxito.
4. Hacé clic en Crear checkout. Copiá el enlace de checkout del panel de éxito y enviáselo al pagador.

​

Notas por país (panel)

​

API

{
  "country": "AR",
  "amount": "1500.00",
  "successUrl": "https://merchant.example/success"
}

​

Argentina (AR)

• La respuesta incluye accountDisplay (alias, CVU/CBU, titular).
• El pagador completa nombre, monto y DNI de 8 dígitos en la página hospedada.
• Completado cuando una transferencia entrante coincide monto + DNI en la cuenta asignada.

​

Brasil (BR)

• payer.name, payer.document (CPF o CNPJ — solo dígitos o con puntuación) y payer.email obligatorios al crear.
• La respuesta puede incluir qrCode y pixCopiaECola.

​

Chile (CL)

• paymentMethodId y customer obligatorios — ver Cash-in Chile para listar métodos de pago.

​

Bolivia (BO)

• payer.name, payer.document (CI o documento del pagador) y payer.email obligatorios al crear.
• La respuesta puede incluir qrCode para que el pagador lo escanee.

​

Colombia (CO)

• Solo checkout hospedado. No existe POST /api/v1/co/transactions/inbound. Ver Cash-in Colombia.
• Obligatorio: country: "CO", amount y successUrl. Sin nombre, documento ni email del pagador.
• HG configura los medios de pago disponibles. La solicitud de creación no los elige.
• La cuenta debe ser COP y Operativa.
• Opcional: accountId, cancelUrl, webhookUrl, metadata, reference, idempotencyKey, expiresInSeconds y locale.
• expiresInSeconds es opcional. El valor predeterminado es 86400 segundos. El máximo es 604800 segundos. locale es opcional y solo admite es o en.
• La respuesta incluye checkoutUrl y omite checkoutUrlProvider.
• GET /api/v1/checkouts, GET /api/v1/checkouts/{id} y POST /api/v1/checkouts/{id}/cancel omiten providerData para Colombia.
• El pagador abre checkoutUrl, completa el pago y vuelve a la página de éxito de HG. Tu successUrl se usa solo después de confirmar el pago.
• Después de expiresAt, el get y el list del comercio siguen devolviendo status: pending. La sesión del pagador informa expired. Cancelar un checkout pendiente sigue dejando cancelled.
• Bloqueada o Cerrada devuelve 403 con code: ACCOUNT_NOT_OPERATIVE. Restringida devuelve 403 con code: RESTRICTED. Una cuenta que no está lista para el checkout devuelve 400 con error: "Account is not ready for checkout".
• Una cuenta que no es una cuenta de checkout en COP devuelve 400 con error: "Account is not supported for this checkout country". Eso es distinto del 400 con error: "Account is not ready for checkout".
• Si no se puede crear la sesión hospedada, la API devuelve 502 con error: "Failed to create CO payment with provider".

​

Ejemplo (Brasil)

curl -X POST https://hg.cash/api/v1/checkouts \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "country": "BR",
    "amount": "100.50",
    "successUrl": "https://merchant.example/success",
    "payer": {
      "name": "Federico Autuori",
      "document": "957.937.532-14",
      "email": "fautuori@gmail.com"
    }
  }'

​

Ejemplo (Bolivia)

curl -X POST https://hg.cash/api/v1/checkouts \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "country": "BO",
    "amount": "150.00",
    "successUrl": "https://merchant.example/success",
    "payer": {
      "name": "Juan Pérez",
      "document": "12345678",
      "email": "payer@example.com"
    }
  }'

​

Ejemplo (Colombia)

curl -X POST https://hg.cash/api/v1/checkouts \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "country": "CO",
    "accountId": "YOUR_ACCOUNT_UUID",
    "amount": "50000.00",
    "successUrl": "https://merchant.example/success"
  }'

​

Ejemplo (Argentina)

curl -X POST https://hg.cash/api/v1/checkouts \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "country": "AR",
    "amount": "1500.00",
    "successUrl": "https://merchant.example/success",
    "cancelUrl": "https://merchant.example/cancel",
    "webhookUrl": "https://merchant.example/hooks/checkout",
    "metadata": { "orderId": "ORD-42" }
  }'

​

Relacionado

• Introducción — Estados y webhooks
• Validar pagos
• Conciliar checkouts
• Referencia API → Checkouts → Create checkout session