Skip to main content

​
Visão geral

O cash-in no Brasil cria uma cobrança PIX em conta BRL. A API retorna QR code e/ou copia e cola PIX. A transação fica em pending até a confirmação do pagamento. A conta deve ser BRL e país BR.

​
Pré-requisitos

  • Token Bearer com acesso à conta BRL
  • email do pagador (obrigatório na API)
  • document do pagador — CPF ou CNPJ (obrigatório na API)

​
Fluxo

  1. POST /api/v1/br/transactions/inbound — accountId, amount, email e document
  2. Exibir qrCode ou pixCopiaECola ao pagador
  3. Opcional: GET /api/v1/br/transactions/{id}/status ou webhookUrl — veja Recebimento de webhooks

​
Exemplo

A transação começa em pending e vai para done quando o PIX é confirmado. Quando o pagamento é confirmado, a HG.Cash envia um webhook de movimentação de conta (topic TRANSACTION, eventType status_change) para a webhookUrl da solicitação ou para a sua URL de webhook padrão. Se a movimentação armazena um identificador end-to-end de PIX, esse corpo inclui endToEndId. O campo é omitido quando o identificador está ausente ou vazio. Veja Identificador end-to-end PIX.

​
Status da conta

A conta de origem deve estar Operativa. Requisições contra contas Bloqueada ou Cerrada retornam 403 com code: ACCOUNT_NOT_OPERATIVE.