Skip to main content

​
Objetos de Resposta - Transferências

​
Objeto Withdrawal (Criar Transferência)

Retornado pelo endpoint POST /api/public/cashout: 
{
  "id": 12345,
  "amount": "100.00",
  "netAmount": "95.00",
  "pixKey": "11999999999",
  "pixKeyType": "PHONE",
  "status": "PENDING",
  "createdAt": "2024-01-15T10:30:00.000Z",
  "fees": {
    "fixed": "2.00",
    "variable": "3.00",
    "total": "5.00"
  }
}

​
Objeto Withdrawal (Buscar Transferência)

Retornado pelo endpoint GET /api/public/cashout/{id}: 
{
  "id": 12345,
  "amount": "100.00",
  "netAmount": "95.00",
  "pixKey": "11999999999",
  "pixKeyType": "PHONE",
  "status": "PENDING",
  "createdAt": "2024-01-15T10:30:00.000Z",
  "updatedAt": "2024-01-15T10:30:00.000Z",
  "fees": {
    "fixed": "2.00",
    "variable": "3.00",
    "total": "5.00"
  }
}

​
Campos

​
id
integer
required
ID único da transferência
​
amount
string
required
Valor bruto da transferência em reais (formato string)
​
netAmount
string
required
Valor líquido após taxas em reais (formato string)
​
pixKey
string
required
Chave PIX para recebimento
​
pixKeyType
string
required
Tipo da chave PIX utilizada. Valores possíveis: CPF, CNPJ, EMAIL, PHONE, RANDOM
​
status
string
required
Status da transferência. Valores possíveis: PENDING, PROCESSING, COMPLETED, FAILED, CANCELLED
​
createdAt
string
required
Data de criação da transferência (ISO 8601)
​
updatedAt
string
Data da última atualização da transferência (ISO 8601). Apenas no endpoint de busca.
​
fees
object
required
Detalhamento das taxas cobradas
​
fees.fixed
string
required
Taxa fixa em reais (formato string)
​
fees.variable
string
required
Taxa variável em reais (formato string)
​
fees.total
string
required
Total de taxas em reais (formato string)

​
Objeto de Erro

Retornado em caso de erro: 
{
  "message": "Saldo insuficiente para realizar o cashout",
  "errorType": "INSUFFICIENT_BALANCE"
}

​
Campos de Erro

​
message
string
required
Mensagem de erro descritiva
​
errorType
string
Tipo do erro. Valores possíveis:
  • INSUFFICIENT_BALANCE - Saldo insuficiente
  • API_WITHDRAWAL_DISABLED_GLOBALLY - Cashout via API desabilitado globalmente
  • TRANSFER_NOT_ALLOWED - Transferência não permitida
  • MINIMUM_VALUE - Valor abaixo do mínimo permitido
  • MAXIMUM_VALUE - Valor acima do máximo permitido
  • GENERAL_ERROR - Erro geral