> ## 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.

# Criar transação de entrada (Chile)

> Cria uma transação de entrada e retorna uma URL de checkout hospedado.
A conta deve ser CLP no Chile. Inicia em `pending` até a confirmação do pagamento.




## OpenAPI

````yaml /api-reference/openapi.pt-BR.yaml post /cl/transactions/inbound
openapi: 3.1.0
info:
  title: HG.Cash API
  description: >
    # 🚀 API de transações HG.Cash


    API REST moderna para usuários criarem transações de saída a partir de suas
    contas.


    ## 🧾 Como funciona


    - A HG.Cash atribui contas ao seu usuário

    - Quando essas contas têm movimentação (entrada ou saída), a HG.Cash
    notifica o seu backend usando a URL de webhook configurada no painel

    - **Assinatura de webhooks (HMAC)**: Nas configurações da conta é possível
    gerar um segredo de assinatura. Quando configurado, cada POST de webhook
    inclui o cabeçalho `X-HG-Webhook-Signature: sha256=<hex>` com HMAC-SHA256 do
    corpo JSON usando o seu segredo. Verifique no seu endpoint para garantir
    autenticidade.

    - Para criar saques é necessário chamar o endpoint **Cash Out**: **Criar
    solicitação de transação** (`POST /transactions`)


    ## 📊 Primeiros passos


    1. **Gere seu token de API** na página de configurações da conta

    2. **Teste os endpoints** com a documentação interativa

    3. **Implemente** nos seus serviços de backend (nunca exponha tokens no
    frontend)

    4. **Monitore** a integração e trate erros adequadamente


    ## 🔐 Autenticação


    Esta API usa autenticação **Bearer Token**. Inclua o token de API do usuário
    no cabeçalho Authorization, por exemplo `Authorization: Bearer
    cash_your_token_here`.


    ## ⚠️ Segurança


    - Não compartilhe nem exponha o token de autenticação da API

    - Armazene tokens apenas em servidores backend seguros

    - Todas as chamadas devem ser feitas a partir de backends seguros

    - Se o token for comprometido, entre em contato com os administradores
    imediatamente
  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 produção
  - url: http://dev.hg.cash/api/v1
    description: Servidor de desenvolvimento
security:
  - bearerAuth: []
tags:
  - name: Transações
    description: >-
      Gestão de transações — Criar e gerenciar transações no sistema HG.Cash.
      Todos os endpoints de transação exigem autenticação.
  - name: Contas
    description: >-
      Contas — Obter informações de conta e saldos do usuário autenticado. Todos
      os endpoints de conta exigem autenticação.
  - name: Dados de referência
    description: >-
      Dados de referência — Obter dados de referência como status e tipos de
      transação. Esses endpoints exigem autenticação.
  - name: Webhooks
    description: Webhooks — Notificações de eventos enviadas ao seu endpoint HTTP.
  - name: Brasil
    description: Brasil — Criar e consultar transações PIX (BRL).
  - name: Chile
    description: Chile — Checkout hospedado e payouts bancários (CLP).
  - name: Bolívia
    description: Bolívia — Cash-in com QR e payouts ACH (BOB).
  - name: Checkouts
    description: Sessões de checkout hospedado para AR, BR, CL e BO
paths:
  /cl/transactions/inbound:
    post:
      tags:
        - Chile
      summary: Criar transação de entrada (Chile)
      description: >
        Cria uma transação de entrada e retorna uma URL de checkout hospedado.

        A conta deve ser CLP no Chile. Inicia em `pending` até a confirmação do
        pagamento.
      operationId: createClInboundTransaction
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ClInboundTransactionRequest'
      responses:
        '201':
          description: Transação criada
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClInboundTransactionResponse'
        '400':
          description: Requisição inválida
        '401':
          description: Não autorizado
        '403':
          description: Proibido
        '404':
          description: Conta ou método de pagamento não encontrado
        '502':
          description: Não foi possível concluir a operação de pagamento
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChileProviderError'
components:
  schemas:
    ClInboundTransactionRequest:
      type: object
      description: Criar transação de entrada (checkout hospedado) para contas CLP no Chile
      required:
        - accountId
        - paymentMethodId
        - amount
        - customer
      properties:
        accountId:
          type: string
          format: uuid
        paymentMethodId:
          type: string
          format: uuid
          description: ID retornado por GET /cl/payment-methods
        amount:
          oneOf:
            - type: number
              format: decimal
            - type: string
          description: Valor em CLP (ex. 100.50)
        description:
          type: string
        webhookUrl:
          type: string
          format: uri
        returnUrl:
          type: string
          format: uri
        language:
          type: string
          enum:
            - EN
            - ES
            - PT
        customer:
          $ref: '#/components/schemas/ClInboundCustomer'
    ClInboundTransactionResponse:
      type: object
      required:
        - id
        - checkoutUrl
        - status
      properties:
        id:
          type: string
          format: uuid
        checkoutUrl:
          type: string
          format: uri
          description: URL de checkout hospedado para redirecionar o pagador
        status:
          type: string
          enum:
            - pending
    ChileProviderError:
      type: object
      required:
        - error
        - code
        - type
      description: >-
        Erro ao concluir uma operação de pagamento no Chile (sem detalhes
        internos)
      properties:
        error:
          type: string
        code:
          type: string
        type:
          type: string
    ClInboundCustomer:
      type: object
      required:
        - firstName
        - lastName
        - email
        - personalId
        - ip
      properties:
        firstName:
          type: string
        lastName:
          type: string
        email:
          type: string
          format: email
        personalId:
          type: string
          description: Documento de identidade chileno (cédula)
        ip:
          type: string
        city:
          type: string
        address:
          type: string
        zip:
          type: string
        phone:
          type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >
        Token de autenticação da API do usuário com o formato
        `cash_<64-char-hex>`. Valor de exemplo
        `cash_16cdc3b6f83c72d9d2680adca4f430962981f6bf32613a129dded0aa060387d2`.

````