Agregadores y PSPaaS
Sucursales
3min
A partir de esta especificación se podrán crear sucursales de un subcomercio o entidad dentro de la plataforma, siempre y cuando esté habilitado dicho módulo.
POST
Request
Header Parameters
x-api-key
required
String
API Key del operador
x-access-token
required
String
Access Token del Operador
x-suga-entity
required
String
ID del comercio sobre el cual se desean crear las sucursales
Body Parameters
name
required
String
Nombre de fantasía de la sucursal
reference
optional
String
Referencia única que permita identificar a la sucursal dentro del comercio. Si no se envía se generara una automáticamente. Este parámetro no puede ser editado posteriormente.
address
required
Object
Dirección de la Sucursal.
state
required
String
Provincia o Estado de la sucursal. Para Argentina se debe utilizar la clasificacion propuesta.
city
required
String
Ciudad de la Sucursal.
zipCode
required
String
Código Postal. En Argentina se debe utilizar el Código Postal Argentino ( CPA ) cuyo formato es LNNNNLLL.
email
optional
String
Email de la sucursal. Si no se envía se considera el email del comercio.
phone
optional
String
Teléfono de la sucursal. Si no se envía se considera el teléfono del comercio.
accountType
optional
String
Permite definir una cuenta bancaria o virtual para el destino de los fondos de la sucursal, en el caso que sea diferente al comercio. Aplicar sólo en los casos requeridos y previa autorización de SUGA
accountNumber
optional
String
En el caso de especificar una cuenta, indica el número de cuenta de destino de los fondos.
En caso de no utilizar referencia, es posible utilizar el siguiente método para editar una sucursal:
PUT
Request
Header Parameters
x-api-key
required
String
API Key del operador
x-access-token
required
String
Access Token del Operador
x-suga-entity
required
String
ID del comercio sobre el cual se desea editar la sucursal
Body Parameters
name
optional
String
Nombre de fantasía de la sucursal
address
optional
Object
Dirección de la Sucursal.
state
optional
String
Provincia o Estado de la sucursal. Para Argentina se debe utilizar la clasificacion propuesta.
city
optional
String
Ciudad de la Sucursal.
zipCode
optional
String
Código Postal. En Argentina se debe utilizar el Código Postal Argentino ( CPA ) cuyo formato es LNNNNLLL.
email
optional
String
Email de la sucursal. Si no se envía se considera el email del comercio.
phone
optional
String
Teléfono de la sucursal. Si no se envía se considera el teléfono del comercio.
accountType
optional
String
Permite definir una cuenta bancaria o virtual para el destino de los fondos de la sucursal, en el caso que sea diferente al comercio. Aplicar sólo en los casos requeridos y previa autorización de SUGA
accountNumber
optional
String
En el caso de especificar una cuenta, indica el número de cuenta de destino de los fondos.
Los posibles códigos de error al crear o modificar una sucursal son:
- BRANCH:INVALID_REFERENCE
- ENTITY:COUNTRY_INVALID_STATE
- ENTITY:INVALID_MCC
- ENTITY:INVALID_ZIP_CODE
- ENTITY:INVALID_ADDRESS
- ENTITY:INVALID_ACCOUNT
- NDFE -> El {branch-id} enviado no corresponde a una sucursal válida
PUT
Request
Path Params
id
required
String
ID de la sucursal que se quiere inactivar
Header Parameters
x-api-key
required
String
API Key del operador
x-access-token
required
String
Access Token del operador
x-suga-entity
required
String
ID del comercio sobre el cual se desean gestionar las sucursales
PUT
Request
Path Params
id
required
String
ID de la sucursal que se quiere reactivar
Header Parameters
x-api-key
required
String
API Key del Operador
x-access-token
required
String
Access Token del Operador
x-suga-entity
required
String
ID del comercio sobre el cual se desean gestionar las sucursales
Updated 14 Jan 2024
Did this page help you?