Create checkouts

​

Dashboard

1. Open Checkouts in the sidebar (/app/checkouts).
2. Review the stats row and recent sessions on the overview.
3. In Create checkout, choose country, account (optional—HG.Cash picks an eligible operative account if omitted), amount, and success URL.
4. Click Create checkout. Copy the checkout link from the success panel and send it to your payer.

​

Country notes (dashboard)

​

API

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

​

Argentina (AR)

• Response includes accountDisplay (alias, CVU/CBU, holder).
• Payer completes name, amount, and 8-digit DNI on the hosted page.
• Completion when an inbound transfer matches amount + DNI on the assigned account.

​

Brazil (BR)

• payer.name, payer.document (CPF or CNPJ — digits only or formatted), and payer.email required on create.
• Response may include qrCode and pixCopiaECola.

​

Chile (CL)

• paymentMethodId and customer required — see Chile cash-in for payment method listing.

​

Bolivia (BO)

• payer.name, payer.document (payer CI or document ID), and payer.email required on create.
• Response may include qrCode for the payer to scan.

​

Colombia (CO)

• Hosted checkout only. There is no POST /api/v1/co/transactions/inbound. See Colombia cash-in.
• Required: country: "CO", amount, and successUrl. No payer name, document, or email.
• HG configures the available payment methods. The create request does not choose them.
• The account must be COP and Operativa.
• Optional: accountId, cancelUrl, webhookUrl, metadata, reference, idempotencyKey, expiresInSeconds, and locale.
• expiresInSeconds is optional. The default is 86400 seconds. The maximum is 604800 seconds. locale is optional and is only es or en.
• The response includes checkoutUrl and omits checkoutUrlProvider.
• GET /api/v1/checkouts, GET /api/v1/checkouts/{id}, and POST /api/v1/checkouts/{id}/cancel omit providerData for Colombia.
• The payer opens checkoutUrl, completes payment, and returns to the HG success page. Your successUrl is used only after payment is confirmed.
• After expiresAt, merchant get and list still return status: pending. The payer session reports expired. Cancelling a pending checkout still sets cancelled.
• Bloqueada or Cerrada returns 403 with code: ACCOUNT_NOT_OPERATIVE. Restringida returns 403 with code: RESTRICTED. An account that is not ready for checkout returns 400 with error: "Account is not ready for checkout".
• An account that is not a COP checkout account returns 400 with error: "Account is not supported for this checkout country". That is separate from 400 with error: "Account is not ready for checkout".
• If the hosted session cannot be created, the API returns 502 with error: "Failed to create CO payment with provider".

​

Example (Brazil)

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"
    }
  }'

​

Example (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"
    }
  }'

​

Example (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"
  }'

​

Example (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" }
  }'

​

Related

• Introduction — Statuses and webhooks
• Validate payments
• Reconcile checkouts
• API reference → Checkouts → Create checkout session