Listar sucursales

Esta sección detalla el uso del endpoint para consultar las sucursales de tu comercio. Utiliza esta información para asociar una sucursal a tus transacciones y links de pago mediante el campo branchId.

Detalles del endpoint

Método: GET
URL: /api/v1/companies/branches

El endpoint devuelve la lista de sucursales registradas para tu comercio.

Configuración de la solicitud

Headers

Header	Descripción
`X-API-KEY`	API Key generada en Cubo Admin.

Si aún no has generado tu API Key, revisa nuestra sección de autenticación.

Ejemplos de uso

JavaScript


fetch('https://<CUBO_API_URL>/api/v1/companies/branches', {
  method: 'GET',
  headers: {
    'X-API-KEY': 'TU_API_KEY_AQUI',
  },
})
  .then(response => response.json())
  .then(data => console.log(data))
  .catch(error => console.error('Error:', error));

Respuestas del servidor

✅ Respuesta exitosa

Devuelve la lista de sucursales del comercio:


[
  {
    "id": 1,
    "branchName": "Principal",
    "attributes": null
  },
  {
    "id": 2,
    "branchName": "Sucursal 2",
    "attributes": "1.2"
  }
]

Campo	Tipo	Descripción
`id`	`number`	Identificador de la sucursal. Se envía como `branchId` al procesar un pago o crear un link de pago.
`branchName`	`string`	Nombre de la sucursal.
`attributes`	`string \| null`	Atributos adicionales de la sucursal.

El id de la sucursal es el valor que debes enviar en el campo branchId al procesar un pago o crear un link de pago.

❌ Respuesta de error


{
  "statusCode": 400,
  "message": ["Error en la solicitud"],
  "error": "Bad Request"
}