Cash In - Visão Geral

O Cash In permite receber pagamentos via PIX, Cartão de Crédito e Boleto. Suporte completo para checkout redirect e integração direta via API.

Métodos de Pagamento Disponíveis

Fluxo de Criação

1. Faça uma requisição POST /v1/charges com os dados da cobrança
2. Receba os dados de pagamento (QR Code, linha digitável, etc.)
3. Monitore o status via GET /v1/charges/{id} ou webhooks
4. Receba notificação quando o pagamento for confirmado (via webhook global ou callback_url pontual)

Requisitos de Endereço

Os requisitos de endereço variam conforme o método de pagamento:

Estrutura do Endereço:

{
  "customer": {
    "address": {
      "street": "Rua das Flores",      // Obrigatório (se address fornecido)
      "number": "123",                  // Opcional
      "complement": "Apto 45",          // Opcional
      "neighborhood": "Centro",          // Opcional
      "city": "São Paulo",              // Obrigatório (se address fornecido)
      "state": "SP",                    // Obrigatório (se address fornecido, 2 caracteres)
      "zipcode": "01234567",            // Obrigatório (se address fornecido, 8 dígitos)
      "country": "BR"                   // Opcional (padrão: "BR")
    }
  },
  "shipping": {                         // Opcional - endereço de entrega
    "address": { /* mesma estrutura */ }
  }
}

Para mais detalhes, consulte a documentação específica de cada método de pagamento.

Associação com Operações e Produtos

Você pode opcionalmente associar uma cobrança a uma Operação (Store) e/ou Produto do seu dashboard para melhor organização e rastreabilidade:

• store_id: ID da operação (store) criada no dashboard. Se não informado, será usada a operação padrão do seller. Nota: Uma operação padrão é criada automaticamente quando você se cadastra na plataforma, permitindo que você comece a usar a API imediatamente sem precisar criar uma operação manualmente.
• product_id: ID do produto criado no dashboard. Opcional, mas útil para rastrear cobranças relacionadas a produtos específicos.

Nota: Esses campos são opcionais e não afetam o processamento do pagamento. Eles servem apenas para organização e sincronização com o dashboard do seller.

Notificações

Você pode receber notificações de duas formas:

• Webhooks Globais: Configure no dashboard para receber notificações de todas as cobranças
• Callback URL Pontual: Envie callback_url no payload para receber notificações apenas desta cobrança específica

Ambas as opções funcionam em conjunto, permitindo máxima flexibilidade na integração. Saiba mais sobre Webhooks →

Checkout Redirect

Você pode criar cobranças com checkout redirect, onde o cliente é redirecionado para uma página de pagamento:

{
  "amount": 10000,
  "payment_method": "pix",
  "checkout": {
    "mode": "redirect",
    "success_url": "https://seusite.com.br/success",
    "cancel_url": "https://seusite.com.br/cancel"
  }
}

Quando usar checkout.mode: "redirect", a resposta incluirá um checkout_url para redirecionar o cliente.

Status da Cobrança