Pular para o conteúdo principal

Buscar Status do Saque

Utilize este endpoint para consultar apenas o status de um saque específico pelo id.

A resposta traz somente o id e o status, sem os demais dados do saque. Quando precisar do registro completo, use Buscar Saque.

Ambientes Disponíveis​

https://api.gateway.com.br/core

Endpoint​

  • Método: GET
  • Endpoint: /withdrawal/{id}/status
  • Autenticação: Bearer token

Path Params​

NomeTipoObrigatórioDescriçãoValidações
idstring (UUID)SimIdentificador do saqueDeve ser UUID válido

Exemplo de Requisição​

curl --request GET \
--url https://api.gateway.com.br/core/withdrawal/553e8400-e29b-41d4-a716-436251480000/status \
--header 'Authorization: Bearer seu-token-jwt'

Resposta de Sucesso​

CampoTipoObrigatórioDescrição
idstring (UUID)SimIdentificador único do saque
statusstring (enum) - PENDING, PROCESSING, PROCESSED, FAILED, CANCELED, REFUNDED, REJECTED, PENDING_COMPLIANCESim
  • PENDING: Saque criado, aguardando processamento
  • PROCESSING: Saque em processamento
  • PROCESSED: Saque processado com sucesso
  • FAILED: Erro no processamento
  • CANCELED: Saque cancelado
  • REFUNDED: Saque estornado
  • REJECTED: Saque rejeitado pela gateway
  • PENDING_COMPLIANCE: Saque pendente de análise de compliance

Exemplo de Resposta​

{
"id": "553e8400-e29b-41d4-a716-436251480000",
"status": "PROCESSED"
}

Possíveis Erros​

CódigoDescriçãoSolução
401Credenciais inválidasVerifique suas credenciais
403Sem permissão/autorizaçãoContate o suporte
404Registro não encontradoVerifique o id informado
422Dados inválidos ou faltandoVerifique o formato dos dados
422ValidaçõesContate o suporte
500Erro internoContate o suporte