Configurar Preferencias

Permite habilitar o deshabilitar el modo kiosco en uno o varios dispositivos PinPad. Es posible enviar hasta 25 dispositivos por solicitud.

El encabezado contendrá la Clave con el prefijo Basic, Para crear un intento de pago implementa la siguiente función desde tu backend:

curl --location 'https://api.payclip.io/f2f/pinpad/v1/devices' \
--header 'Authorization: Basic {TOKEN}' \
--header 'Content-Type: application/json' \
--data '{
    "devices": ["MyClipPosSerialNumber1", "MyClipPosSerialNumber2"], 
    "preferences": {
        "is_kiosk_mode_enabled": true,
	 "timeout_seg": 10
    }
}'

Body parameters (parámetros del cuerpo de la solicitud)

La siguiente tabla describe el esquema de los parámetros del body de la solicitud:

Parámetro

Descripción

Tipo

Notas

Requerido

Por defecto

devices

Los números de serie de los dispositivos que serán afectados.

Array

Máximo 25 dispositivos por request.

Requerido

preferences

Preferencias que afectarán a los dispositivos.

Object

Requerido

is_kiosk_mode_enabled

Activa o desactiva el modo kiosco en el dispositivo.

Boolean

Opcional

false

timeout_seg

Define el tiempo de inactividad, en segundos, antes de cancelar la orden.

Integer

Utiliza null para deshabilitar el tiempo de espera.

Opcional

null



Body Params
devices
array of strings
required
length between 1 and 25

Lista de números de serie de los dispositivos PinPad.

Se permite enviar un máximo de 25 dispositivos por solicitud.

devices*
preferences
object
required

Configuración del modo kiosco.

Responses
200

Configuración aplicada correctamente.

400

La solicitud contiene parámetros inválidos.

401

No autorizado.

500

Error interno del servidor.

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here!