Actualizar sub-cuenta (CVU)
Nivel de seguridad requerida para este servicio
Muy Alta (accessToken + mutual TLS + HMAC + VPN)
Objetivo
Este servicio permite cambiar las propiedades de una sub-cuenta:
- Suspender una sub-cuenta
- Dar de baja una sub-cuenta
- Cambiar el alias de una sub-cuenta
Request
curl -X PATCH "https://$env/v2/apibank/sub-account/$sub-account" \
-H 'Authorization: $YOUR_ACCESS_TOKEN' \
-H "Content-Type: application/json" \
-d '{
"status": "suspended"
}'
env
: Entorno de la API, como producción o desarrollo.YOUR_ACCESS_TOKEN
: Token obtenido en el servicio de autenticación.
Ejemplo de Cuerpo del Mensaje
JSON
{
"status": "suspended"
}
Las Propiedades que pueden ser actualizadas son:
accountLabel
: El valor será el nuevo alias de la cuenta. Valores válidos. Cadena de texto de hasta 14 carácteres alganuméricos sin espacios. Puede utilizarse punto. La siguiente expresión regular premite validar la cadena: ^[a-zA-Z0-9.]14$status
: El valor será el nuevo estado de la cuenta. Valores posibles:- SUSPENDED - Impide ingresos y egresos desde la sub-cuenta.
- BLOQUED - Este estado es irreversible. Da la baja de la misma.
- ACTIVE - Es el estado normal de la sub-cuenta. El único estado previo posible es "SUSPENDED"
Ejemplo de Respuestas:
JSON Response Body
{
"result": "success",
"message": "Account updated successfully.",
"data": {
"accountId": "1234567890",
"status": "suspended",
"accountLabel": "MAPA.TOPO.CERA",
"updatedAt": "2024-04-13T18:30:45Z"
}
}