Pular para o conteúdo principal
POST
Criar transação de entrada (Brasil)

Autorizações

Authorization
string
header
obrigatório

Token de autenticação da API do usuário com o formato cash_<64-char-hex>. Valor de exemplo cash_16cdc3b6f83c72d9d2680adca4f430962981f6bf32613a129dded0aa060387d2.

Corpo

application/json

Solicitação para criar uma transação de entrada (cobrança) em contas BRL do Brasil

accountId
string<uuid>
obrigatório

ID da conta que receberá os fundos

amount
number<decimal>
obrigatório

Valor a receber (positivo)

email
string<email>
obrigatório

E-mail do pagador para a cobrança

document
string
obrigatório

CPF ou CNPJ do pagador (somente dígitos, ou com pontuação)

webhookUrl
string<uri>

URL opcional para receber atualizações de status

Resposta

Transação criada

id
string<uuid>
obrigatório

ID da transação HG.Cash

status
enum<string>
obrigatório
Opções disponíveis:
pending
qrCode
string

String do QR code para o pagador escanear (base64 ou string PIX)

pixCopiaECola
string

String PIX copia e cola (alternativa ao QR code)