Get Withdrawal Status
Use this endpoint to get only the status of a specific withdrawal by its id.
The response carries only the id and the status, without the rest of the withdrawal data. When you need the complete record, use Get Withdrawal.
Available Environments
- Production
https://api.gateway.com.br/core
Endpoint
- Method:
GET - Endpoint:
/withdrawal/{id}/status - Authentication: Bearer token
Path Params
| Name | Type | Required | Description | Validations |
|---|---|---|---|---|
id | string (UUID) | Yes | Withdrawal identifier | Must be a valid UUID |
Request Example
- cURL
- JavaScript
curl --request GET \
--url https://api.gateway.com.br/core/withdrawal/553e8400-e29b-41d4-a716-436251480000/status \
--header 'Authorization: Bearer your-jwt-token'
const response = await fetch('https://api.gateway.com.br/core/withdrawal/553e8400-e29b-41d4-a716-436251480000/status', {
method: 'GET',
headers: {
'Authorization': 'Bearer your-jwt-token'
}
});
const data = await response.json();
Success Response
| Field | Type | Required | Description |
|---|---|---|---|
id | string (UUID) | Yes | Unique identifier of the withdrawal |
status | string (enum) - PENDING, PROCESSING, PROCESSED, FAILED, CANCELED, REFUNDED, REJECTED, PENDING_COMPLIANCE | Yes |
|
Response Example
{
"id": "553e8400-e29b-41d4-a716-436251480000",
"status": "PROCESSED"
}
Possible Errors
| Code | Description | Solution |
|---|---|---|
| 401 | Invalid credentials | Check your credentials |
| 403 | No permission/authorization | Contact support |
| 404 | Record not found | Check the id you sent |
| 422 | Invalid or missing data | Check the format of the data |
| 422 | Validations | Contact support |
| 500 | Internal error | Contact support |