Pular para o conteúdo principal
POST
Criar transação de saída (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 saída (saque) em contas BRL do Brasil

accountId
string<uuid>
obrigatório
amount
number<decimal>
obrigatório
name
string
obrigatório

Nome do destinatário

keyType
enum<string>
obrigatório

Tipo de chave PIX (document=CPF, evp=chave aleatória)

Opções disponíveis:
document,
email,
evp,
phone,
cnpj
keyPix
string
obrigatório

Valor da chave PIX (e-mail, CPF, CNPJ, telefone ou chave aleatória)

webhookUrl
string<uri>

Resposta

Transação criada. Retorna status: processing quando o provedor aceitou o saque (HTTP 200). Retorna status: cancelled quando o provedor rejeitou ou falhou (não-200); a transação é armazenada e marcada como cancelada.

id
string<uuid>
obrigatório

ID da transação HG.Cash

status
enum<string>
obrigatório
  • processing: O provedor aceitou o saque (HTTP 200). A transação está sendo processada.
  • cancelled: O provedor rejeitou ou falhou (não-200). A transação foi marcada como cancelada.
Opções disponíveis:
processing,
cancelled