Objeto Withdrawal (Criar Transferência)
Retornado pelo endpointPOST /api/public/cashout:
Objeto Withdrawal (Buscar Transferência)
Retornado pelo endpointGET /api/public/cashout/{id}:
Campos
integer
required
ID único da transferência
string
required
Valor bruto da transferência em reais (formato string)
string
required
Valor líquido após taxas em reais (formato string)
string
required
Chave PIX para recebimento
string
required
Tipo da chave PIX utilizada. Valores possíveis:
CPF, CNPJ, EMAIL, PHONE, RANDOMstring
required
Status da transferência. Valores possíveis:
PENDING, PROCESSING, COMPLETED, FAILED, CANCELLEDstring
required
Data de criação da transferência (ISO 8601)
string
Data da última atualização da transferência (ISO 8601). Apenas no endpoint de busca.
object
required
Detalhamento das taxas cobradas
string
required
Taxa fixa em reais (formato string)
string
required
Taxa variável em reais (formato string)
string
required
Total de taxas em reais (formato string)
Objeto de Erro
Retornado em caso de erro:Campos de Erro
string
required
Mensagem de erro descritiva
string
Tipo do erro. Valores possíveis:
INSUFFICIENT_BALANCE- Saldo insuficienteAPI_WITHDRAWAL_DISABLED_GLOBALLY- Cashout via API desabilitado globalmenteTRANSFER_NOT_ALLOWED- Transferência não permitidaMINIMUM_VALUE- Valor abaixo do mínimo permitidoMAXIMUM_VALUE- Valor acima do máximo permitidoGENERAL_ERROR- Erro geral

