Crear una Intención de Pago

Crea una intención de pago en un dispositivo PinPad registrado en tu cuenta Clip.

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/payment' \
--header 'Authorization: Basic {TOKEN}' \
--header 'Content-Type: application/json' \
--data '{
    "amount": "200.50",
    "tip_amount": "10",
    "reference": "test-demo-6a405173-c661-414a-9a8f-ecc77a9afe3f",
    "serial_number_pos":"P8220724000042",
    "webhook_url": "https://webhook.site/34bb8f7a-9646-4cc9-8694-4307ec53fbb4",
    "preferences": {
        "is_auto_return_enabled": false,
        "is_tip_enabled": false,
        "is_msi_enabled": true,
        "is_mci_enabled": true,
        "is_dcc_enabled": true,
        "is_retry_enabled": true,
        "is_share_enabled": true,
        "is_auto_print_receipt_enabled": false,
        "is_split_payment_enabled": true,
        "redirect_package_name": "com.payclip.blaze.client.app",
        "tip_options": [10,18]
        
    }
}'

Objeto Completo

La siguiente tabla describe los elementos del objeto de respuesta completo que recibirá tu sistema

Elemento

Descripción

Tipo

Notas

amount

Monto de la transacción.

String

Este parámetro es requerido

tip_amount

Monto de la propina.

String

reference

ID de referencia externa.

String

Este parámetro es requerido

serial_number_pos

Número de serie del terminal Clip

String

Este parámetro es requerido

webhook_url

URL donde se enviarán las notificaciones.

String

De no venir este valor se utilizará por default el definido en el panel de desarrolladores.

preferences

Valores personalizables.

Object

Opciones que pueden activarse o desactivarse

is_auto_return_enabled

Parámetro para configurar el proceso del terminal al finalizar.

Boolean

is_tip_enabled

Parámetro para la configuración de la pantalla de propinas del terminal.

Boolean

is_msi_enabled

Parámetro para habilitar cuotas sin intereses.

Boolean

Para conocer los términos y condiciones sobre cuotas, visita el sitio de Clip.

is_mci_enabled

Parámetro para habilitar cuotas con intereses.

Boolean

Para conocer los términos y condiciones sobre cuotas, visita el sitio de Clip.

is_dcc_enabled

Parámetro para habilitar la conversión dinámica de moneda actual.

Boolean

is_retry_enabled

Parámetro para permitir que los usuarios reintenten sus pagos cuando estos fallan.

Boolean

is_share_enabled

Parámetro para habilitar botones de compartir en pantalla de detalle del pago.

Boolean

is_auto_print_receipt_enabled

Parámetro para mandar a imprimir en automático al finalizar.

Boolean

is_split_payment_enabled

Parámetro para para habilitar la división del pago total en múltiples transacciones.

Boolean

redirect_package_name

Después de la transacción pinpad redirecciona hacia una app instalada dentro de las terminales.

String

En caso de que el packageName sea incorrecto pin pad app volverá a la vista principal.

tip_options

Parámetro para definir las propinas que aparecen en la vista de Tips.

Array

Los valores permitidos son números enteros entre 1 y 100. Permite entre 1 y tres opciones.

Consideraciones Clave

  1. La Api de PinPad es compatible solo con los LectoresTotal 2 y Ultra.
  2. Errores comunes: Problemas de conectividad o identificadores de terminal incorrectos desencadenará una respuesta de excepción, se requiere contar con red una WiFi estable mínimo 10MB/s
🚧

Importante

Para instalar el aplicativo de PinPad en tu Lector Clip, envia un correo electronico a [email protected] más el número de serie de tu lector

Es necesario que también verifiques tu identidad con Clip. Puedes encontrar más información sobre cómo verificar tu identidad aquí.aquí.

📘

¿Necesitas Ayuda?

Si lo que buscas no está documentado, contáctanos por el siguiente medio:

Llamada de prueba

Puedes realizar una llamada de prueba, únicamente asegúrate de poner tu token de autenticación en el campo "Header: Autorization" del widget localizado a tu derecha y dale click en el botón "Try It!":

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