> ## 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 sessão de checkout > Cria um checkout hospedado para AR (transferência + DNI), BR (QR PIX), CL (iframe do provedor) ou BO (pagamento QR). Retorna `checkoutUrl` para o pagador e campos opcionais do provedor (QR, URL do iframe). ## OpenAPI ````yaml /api-reference/openapi.pt-BR.yaml post /checkouts 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=` 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: /checkouts: post: tags: - Checkouts summary: Criar sessão de checkout description: > Cria um checkout hospedado para AR (transferência + DNI), BR (QR PIX), CL (iframe do provedor) ou BO (pagamento QR). Retorna `checkoutUrl` para o pagador e campos opcionais do provedor (QR, URL do iframe). operationId: createCheckout requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateCheckoutRequest' responses: '201': description: Criado content: application/json: schema: $ref: '#/components/schemas/CreateCheckoutResponse' '400': description: Erro de validação '401': description: Não autorizado '403': description: Proibido '500': description: Erro interno do servidor components: schemas: CreateCheckoutRequest: type: object required: - country - amount - successUrl properties: country: type: string enum: - AR - BR - CL - BO description: País do checkout (AR, BR, CL ou BO) amount: type: string description: Valor decimal como string accountId: type: string format: uuid description: ID da conta HG.Cash que receberá o pagamento successUrl: type: string format: uri description: URL de redirecionamento após pagamento bem-sucedido cancelUrl: type: string format: uri description: URL de redirecionamento se o pagador cancelar webhookUrl: type: string format: uri description: URL de webhook opcional para eventos desta sessão expiresInSeconds: type: integer description: Tempo de expiração da sessão em segundos idempotencyKey: type: string description: Chave de idempotência opcional para evitar duplicatas locale: type: string enum: - es - en description: Idioma da interface do checkout metadata: type: object description: Metadados opacos anexados à sessão payer: type: object properties: name: type: string description: Nome completo do pagador (obrigatório para BR e BO) document: type: string description: >- AR DNI de 8 dígitos; BR CPF/CNPJ do pagador; BO CI/documento do pagador email: type: string format: email description: BR exige name, document e email; BO exige name, document e email paymentMethodId: type: string format: uuid description: Obrigatório para CL customer: type: object description: >- Obrigatório para CL (veja os 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 autenticação da API do usuário com o formato `cash_<64-char-hex>`. Valor de exemplo `cash_16cdc3b6f83c72d9d2680adca4f430962981f6bf32613a129dded0aa060387d2`. ````