> ## Documentation Index
> Fetch the complete documentation index at: https://docs.hg.cash/llms.txt
> Use this file to discover all available pages before exploring further.

# Crear sesión de checkout

> Crea un checkout hospedado para AR (transferencia + DNI), BR (QR PIX), CL (iframe del proveedor) o BO (pago QR).
Devuelve `checkoutUrl` para el pagador y campos opcionales del proveedor (QR, URL iframe).




## OpenAPI

````yaml /api-reference/openapi.es.yaml post /checkouts
openapi: 3.1.0
info:
  title: HG.Cash API
  description: >
    # 🚀 API de transacciones HG.Cash


    API REST moderna para que los usuarios creen transacciones de salida desde
    sus cuentas.


    ## 🧾 Cómo funciona


    - HG.Cash asigna cuentas a su usuario

    - Cuando estas cuentas tienen movimientos (entrada o salida), HG.Cash
    notificará su backend usando la URL de webhook que configure en el panel de
    HG.Cash

    - **Firma de webhooks (HMAC)**: En la configuración de la cuenta puede
    generar un secreto de firma. Cuando está configurado, cada POST de webhook
    incluye el encabezado `X-HG-Webhook-Signature: sha256=<hex>` donde el valor
    es HMAC-SHA256 del cuerpo JSON sin procesar usando su secreto. Verifíquelo
    en su endpoint para asegurar que la solicitud es auténtica.

    - Para crear retiros (dinero que sale de sus cuentas), debe llamar al
    endpoint **Cash Out**: **Crear solicitud de transacción** (`POST
    /transactions`)


    ## 📊 Primeros pasos


    1. **Genere su token de API** en la página de configuración de la cuenta

    2. **Pruebe los endpoints** usando la documentación interactiva a
    continuación

    3. **Implemente** en sus servicios de backend (nunca exponga tokens en el
    frontend)

    4. **Supervise** su integración y maneje los errores adecuadamente


    ## 🔐 Autenticación


    Esta API usa autenticación **Bearer Token**. Incluya el token de API del
    usuario en el encabezado Authorization, por ejemplo `Authorization: Bearer
    cash_your_token_here`.


    ## ⚠️ Notas importantes de seguridad


    - Nunca comparta ni exponga su token de autenticación de API de usuario

    - Almacene los tokens de forma segura solo en sus servidores de backend

    - Todas las llamadas a la API deben realizarse desde servicios de backend
    seguros

    - Contacte a los administradores inmediatamente si su token se ve
    comprometido
  version: 1.0.0
  contact:
    name: HG.Cash API Support
    email: api-support@hg.cash
  license:
    name: MIT
    url: https://opensource.org/licenses/MIT
servers:
  - url: https://hg.cash/api/v1
    description: Servidor de producción
  - url: http://dev.hg.cash/api/v1
    description: Servidor de desarrollo
security:
  - bearerAuth: []
tags:
  - name: Transacciones
    description: >-
      Gestión de transacciones - Crear y administrar transacciones en el sistema
      HG.Cash. Todos los endpoints de transacciones requieren autenticación.
  - name: Cuentas
    description: >-
      Cuentas - Obtener información de cuentas y saldos del usuario autenticado.
      Todos los endpoints de cuentas requieren autenticación.
  - name: Datos de referencia
    description: >-
      Datos de referencia - Obtener datos de referencia como estados y tipos de
      transacción. Estos endpoints requieren autenticación.
  - name: Webhooks
    description: Webhooks - Notificaciones de eventos enviadas a su endpoint HTTP.
  - name: Brasil
    description: Brasil — Crear y consultar transacciones PIX (BRL).
  - name: Chile
    description: Chile — Checkout hospedado y payouts bancarios (CLP).
  - name: Bolivia
    description: Bolivia — Cash-in con QR y payouts ACH (BOB).
  - name: Checkouts
    description: Sesiones de checkout hospedado para AR, BR, CL y BO
paths:
  /checkouts:
    post:
      tags:
        - Checkouts
      summary: Crear sesión de checkout
      description: >
        Crea un checkout hospedado para AR (transferencia + DNI), BR (QR PIX),
        CL (iframe del proveedor) o BO (pago QR).

        Devuelve `checkoutUrl` para el pagador y campos opcionales del proveedor
        (QR, URL iframe).
      operationId: createCheckout
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateCheckoutRequest'
      responses:
        '201':
          description: Creado
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateCheckoutResponse'
        '400':
          description: Error de validación
        '401':
          description: No autorizado
        '403':
          description: Prohibido
        '500':
          description: Error interno del servidor
components:
  schemas:
    CreateCheckoutRequest:
      type: object
      required:
        - country
        - amount
        - successUrl
      properties:
        country:
          type: string
          enum:
            - AR
            - BR
            - CL
            - BO
        amount:
          type: string
          description: Monto decimal como cadena
        accountId:
          type: string
          format: uuid
        successUrl:
          type: string
          format: uri
        cancelUrl:
          type: string
          format: uri
        webhookUrl:
          type: string
          format: uri
        expiresInSeconds:
          type: integer
        idempotencyKey:
          type: string
        locale:
          type: string
          enum:
            - es
            - en
        metadata:
          type: object
        payer:
          type: object
          properties:
            name:
              type: string
              description: Nombre completo del pagador (obligatorio para BR y BO)
            document:
              type: string
              description: >-
                AR DNI de 8 dígitos; BR CPF/CNPJ del pagador; BO CI/documento
                del pagador
            email:
              type: string
              format: email
          description: BR exige name, document y email; BO exige name, document y email
        paymentMethodId:
          type: string
          format: uuid
          description: Obligatorio para CL
        customer:
          type: object
          description: >-
            Obligatorio para CL (ver campos customer de
            ClInboundTransactionRequest)
    CreateCheckoutResponse:
      type: object
      properties:
        id:
          type: string
          format: uuid
        publicToken:
          type: string
        checkoutUrl:
          type: string
          format: uri
        status:
          type: string
        expiresAt:
          type: string
          format: date-time
        accountDisplay:
          type: object
          description: Presente para AR (CVU, alias, titular)
        qrCode:
          type: string
        pixCopiaECola:
          type: string
        checkoutUrlProvider:
          type: string
          format: uri
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >
        Token de autenticación de API de usuario con formato
        `cash_<64-char-hex>`. Valor de ejemplo
        `cash_16cdc3b6f83c72d9d2680adca4f430962981f6bf32613a129dded0aa060387d2`.

````