Crear una sucursal

Crea una cuenta administrada para una sucursal que hereda la configuración de la cuenta padre.

Crea una cuenta administrada para una sucursal o unidad operativa.

La sucursal hereda la configuración, información legal y operación de la cuenta padre. No requiere compliance porque pertenece a la misma entidad jurídica.

Ruta

POST /v1/business/branch

Encabezados

Name	Value
Content-Type*	application/json
x-auth-token*	YOUR_SECRET_TOKEN

Cuerpo de la petición

Name	Type	Description
branch_id*	string	Identificador único de la sucursal para este negocio.
branch_name*	string	Nombre de la sucursal.

Respuesta

200

{
  "message": "Sucursal creada exitosamente",
  "branch_id": "north-zone",
  "branch_name": "Zona Norte",
  "child_type": "BRANCH",
  "managing_business_id": "PAY-001",
  "created_at": "2023-10-15T08:00:00-05:00"
}

400

{
  "internalCode": "Q304",
  "message": "Uno o más campos no se encuentran diligenciados correctamente o no son correctos. Por favor revisa los campos [campo_invalido]"
}

404

{
  "internalCode": "Q304",
  "message": "No se encontró información para la consulta realizada. Verifica los parámetros de búsqueda e inténtalo nuevamente."
}

---

Ejemplo

cURL

curl --location '{{base_url}}/v1/business/branch' \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'x-auth-token: YOUR_SECRET_TOKEN' \
  --data '{
  "branch_id": "north-zone",
  "branch_name": "Zona Norte"
}'