Agregadores y PSPaaS
Puntos de Venta
3min
A partir de esta especificación se podrán crear Puntos de Venta de un comercio o de una sucursal.
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 o sucursal sobre el cual se desea crear el punto de venta
Body Parameters
name
required
String
Nombre de fantasía del punto de venta
reference
optional
String
Referencia única que permita identificar al punto de venta dentro del comercio o sucursal. Si no se envía se generara una automáticamente.
countryCategoryCode
optional
String
Indica el código de actividad a aplicarse en este POS. Si no se envía aplica el principal del comercio.
mcc
optional
String
Contiene el código de categoría del Punto de Venta, si aplica uno diferente al del comercio. Si no se envía, se aplica por defecto el que indica según la actividad del POS o Comercio
email
optional
String
Email del punto de venta. Si no se envía se considera el email del comercio.
phone
optional
String
Teléfono del punto de venta. 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 del punto de venta, en el caso que sea diferente al comercio o sucursal. 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.
PUT
Request
Path Params
uid
required
String
ID del punto de venta que se quiere modificar
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 o sucursal sobre el cual se desea editar el punto de venta
Body Parameters
name
optional
String
Nombre de fantasía del punto de venta
countryCategoryCode
optional
String
Indica el código de actividad a aplicarse en este POS.
mcc
optional
String
Contiene el código de categoría del Punto de Venta, si aplica uno diferente al del comercio.
email
optional
String
Email del punto de venta.
phone
optional
String
Teléfono del punto de venta.
Los posible códigos de error al crear o modificar un Punto de Venta son:
- POS:INVALID_REFERENCE
- POS:INVALID_MCC
- POS:INVALID_ACCOUNT
- POS:POS_NOT_FOUND -> El {uid} no corresponde a un punto de venta válido
PUT
Request
Path Params
uid
required
String
ID del POS 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 los POS
PUT
Request
Path Params
uid
required
String
ID del POS 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 los puntos de venta
Updated 23 Feb 2024
Did this page help you?