Confirmar Intención de Retiro
Utilice este endpoint para efectuar un retiro a partir de una intención creada en Crear Intención de Retiro.
Es el segundo paso del flujo en dos etapas. El monto, el destino y los demás datos ya se enviaron y validaron en la intención, así que aquí solo envía la clave de idempotencia.
Entornos Disponibles
- Producción
https://api.gateway.com.br/core
Endpoint
- Método:
POST - Endpoint:
/withdrawal/intent/{id}/confirm - Autenticación: Bearer token
Path Params
| Nombre | Tipo | Obligatorio | Descripción | Validaciones |
|---|---|---|---|---|
id | string (UUID) | Sí | intentId devuelto por Crear Intención de Retiro | Debe ser un UUID válido |
Request Body
ℹ️ Cada intención sirve para un solo retiro
Una vez confirmada, la intención queda consumida: una segunda llamada con el mismo intentId se rechaza. Y si pasaron los 5 minutos de validez, la intención tampoco se acepta.
| Nombre | Tipo | Obligatorio | Descripción | Validaciones |
|---|---|---|---|---|
idempotencyKey | string | Sí | Identificador único para evitar duplicados | Debe tener entre 8 y 255 caracteres |
Ejemplo de Solicitud
- cURL
- JavaScript
curl --request POST \
--url https://api.gateway.com.br/core/withdrawal/intent/553e8400-e29b-41d4-a716-436251480000/confirm \
--header 'Authorization: Bearer su-token-jwt' \
--header 'Content-Type: application/json' \
--data '{
"idempotencyKey": "unique-key-12345"
}'
const response = await fetch('https://api.gateway.com.br/core/withdrawal/intent/553e8400-e29b-41d4-a716-436251480000/confirm', {
method: 'POST',
headers: {
'Authorization': 'Bearer su-token-jwt',
'Content-Type': 'application/json'
},
body: JSON.stringify({
idempotencyKey: 'unique-key-12345',
})
});
const data = await response.json();
Respuesta Exitosa
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
id | string (UUID) | Sí | Identificador único del retiro |
externalCode | string | No | Su código de referencia |
amount | number | Sí | Monto del retiro (entero, en centavos) |
status | string (enum) - PENDING | Sí |
|
Ejemplo de Respuesta
{
"id": "553e8400-e29b-41d4-a716-436251480001",
"externalCode": "SAQUE-123",
"amount": 10000,
"status": "PENDING"
}
Errores Posibles
| Código | Descripción | Solución |
|---|---|---|
| 401 | Credenciales inválidas | Verifique sus credenciales |
| 403 | Sin permiso/autorización | Contacte al soporte |
| 422 | Datos inválidos o faltantes | Verifique el formato de los datos |
| 422 | Intención no encontrada o expirada | Cree una nueva intención y reenvíela |
| 422 | Intención ya utilizada | Cree una nueva intención para cada retiro |
| 422 | Validaciones | Contacte al soporte |
| 429 | Demasiadas solicitudes | Espere e intente de nuevo |
| 500 | Error interno | Contacte al soporte |