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
- Produção
https://api.gateway.com.br/core
Endpoint
- Método:
GET - Endpoint:
/withdrawal/{id}/status - Autenticação: Bearer token
Path Params
| Nome | Tipo | Obrigatório | Descrição | Validações |
|---|---|---|---|---|
id | string (UUID) | Sim | Identificador do saque | Deve ser UUID válido |
Exemplo de Requisição
- cURL
- JavaScript
curl --request GET \
--url https://api.gateway.com.br/core/withdrawal/553e8400-e29b-41d4-a716-436251480000/status \
--header 'Authorization: Bearer seu-token-jwt'
const response = await fetch('https://api.gateway.com.br/core/withdrawal/553e8400-e29b-41d4-a716-436251480000/status', {
method: 'GET',
headers: {
'Authorization': 'Bearer seu-token-jwt'
}
});
const data = await response.json();
Resposta de Sucesso
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
id | string (UUID) | Sim | Identificador único do saque |
status | string (enum) - PENDING, PROCESSING, PROCESSED, FAILED, CANCELED, REFUNDED, REJECTED, PENDING_COMPLIANCE | Sim |
|
Exemplo de Resposta
{
"id": "553e8400-e29b-41d4-a716-436251480000",
"status": "PROCESSED"
}
Possíveis Erros
| Código | Descrição | Solução |
|---|---|---|
| 401 | Credenciais inválidas | Verifique suas credenciais |
| 403 | Sem permissão/autorização | Contate o suporte |
| 404 | Registro não encontrado | Verifique o id informado |
| 422 | Dados inválidos ou faltando | Verifique o formato dos dados |
| 422 | Validações | Contate o suporte |
| 500 | Erro interno | Contate o suporte |