MÓDULOS
Puntos de Venta

8min
Las siguientes apis te permitirán interactuar con tus puntos de venta y solicitar operaciones de pago
El DEVICE del POS se puede obtener en la pantalla de Configuración => Información del Sistema => Referencia o tomando el Serial Number del dispositivo ( Etiqueta en la parte posterior ) y agregando el identificador de la marca separado por dos puntos.
Marcas:
Ingenico: ING. Ej. "ING:123AAA1235566"
Urovo: URO. Ej. "URO:123AAA1235566"
﻿
Esta api te permitirá generar una intención de cobro sobre un punto de venta
POST
Request
Path Params
device
required
String
ID del dispositivo sobre el que se solicita una operación 
Header Parameters
x-api-key
required
String
API Key de la entidad
x-access-token
required
String
Access Token de la entidad
Content-Type
required
String
application/json
Body Parameters
total
required
Number
Monto de la operación a solicitar
currency
required
String
Moneda de la operación. Formato letras ISO 4217
description
optional
String
Descripción de la operación
reference
optional
String
Reference externa de la operación asignada por el consumidor del servicio. El servicio no permite 2 operaciones aprobadas con el mismo reference
test
optional
Boolean
Indica si la operación se realiza en modo de pruebas
webhook
optional
String
URL donde se realizará la notificación de las diferentes actualizaciones sobre el cobro solicitado.
intent
optional
String
Flujo de la operación, permite soportar operaciones en 2 pasos. Valores posibles: "payment.2-step", "payment.v2". Por defecto la captura de la operación es automática
installments
optional
Array
Permite la limitación de los Planes Activos al pagar la orden. Para realizar dicha limitación se debe enviar un array de referencias/códigos de planes. Los ejemplos puedes encontrarlos más abajo en la documentación. 
sources
optional
Array
Permite la limitación de los medios de pago aceptados. De esta forma, podrán utilizarse los medios aquí definidos.
timeout
optional
Number
Tiempo de vida en minutos durante el cual podrá ser utilizada la intención de cobro, luego de este tiempo no tendrá validez. Por defecto son 15 minutos.
customer
optional
Object
Objeto con los datos del cliente
﻿
Ejemplos del nodo installments:
Existen 3 formas de Limitar Planes:
Ocultar determinados planes de todo el conjunto de planes existentes:
Estos planes se pueden limitar por referencia o por ID de plan
JSON
{
    "installments": ["-ahora_12", "-ahora_18"]
}
{
    "installments": ["-ahora_12", "-ahora_18"]
}
﻿
Limitar los Planes a las elegidos en el Array:
Estos planes se pueden limitar por referencia o por ID de plan
JSON
{
    "installments": ["1", "3", "ahora_12"]
}
{
    "installments": ["1", "3", "ahora_12"]
}
﻿
Mostrar planes especiales basado en Reglas Avanzadas
Cancelar una operación en Progreso
Si una operación está en progreso en el POS se puede cancelar la misma utilizando la API. Sólo se puede cancelar una operación a la vez.
Cancelar operación en progreso en el POS
DELETE
Request
Path Params
device
required
String
ID del dispositivo sobre el que se solicita una operación 
﻿
Webhooks
JSON
{
    "type": "pos",
    "data": {
        "result": true,
         "view": {
            "type": "card"
        },
        "payment": {
            "created": "2024-04-16T23:04:40.523Z",
            "currency": {
              "code": "ARS",
              "locale": "es-AR",
              "symbol": "$",
              "text": "Peso Argentino"
            },
            "description": "Orden 11111111111",
            "id": "3Z6D9YF71L0LGGRR8DRT3W",
            "operation": {
              "type": "payment.v2"
            },
            "reference": "1111111111",
            "requestedCurrency": {
              "code": "ARS",
              "locale": "es-AR",
              "symbol": "$",
              "text": "Peso Argentino"
            },
            "requestedTotal": 145170,
            "riskAnalysis": {
              "band": "N/A",
              "level": "N/A"
            },
            "source": {
              "cardholder": {
                "identification": "12123123",
                "name": "Bruce Wayne"
              },
              "expiration": {
                "month": "06",
                "year": "24"
              },
              "installment": {
                "amount": 145170,
                "count": 1,
                "description": "1 Cuota",
                "reference": "1",
                "tags": [],
                "uid": "NzqWp58GA"
              },
              "name": "Visa Banco Santander",
              "number": "46600000****4601",
              "reference": "visa.santanderrio",
              "transaction": {
                "authorizationCode": "004288",
                "batchNo": "",
                "resultCode": "0",
                "retrievalReferenceNo": "410723133668",
                "ticketNo": "",
                "transactionId": "3Z6D9YF71L0LGGRR8DRT3W"
              },
              "type": "card",
              "variant": "credit"
            },
            "status": {
              "code": "200",
              "data": {},
              "message": "Transacción Aprobada",
              "resultCode": "0",
              "text": "Aprobado",
              "view": "default"
            },
            "total": 145170,
            "updated": "2024-04-16T23:04:42.146Z"
        },
        "entity": {
            "name": "Wayne Inc",
            "uid": "iambatman"
        },
        "customer": {
            "uid": "12123123",
            "name": "Juan Perez Wayne",
            "phone": "12123123",
            "identification": "110303456",
            "email": "[email protected]"
        },
        "user": {
            "name": "Juan Perez Wayne",
            "email": "[email protected]"
        },
        "source": {
            "name": "Visa Banco Santander",
            "reference": "visa.santanderrio",
            "type": "card"
        },
        "pos": {
            "name": "POS Nombre",
			"description": "-",
			"mode": "normal",
			"reference": "POS:MY_REF",
			"terminal": {
				"uid": "GDQ3V8L4EE6AAE5L9NWCK5",
				"reference": "ING:123AAA1235566",
				"serialNumber": "123AAA1235566"
			}
        }
    }
}
{
    "type": "pos",
    "data": {
        "result": true,
         "view": {
            "type": "card"
        },
        "payment": {
            "created": "2024-04-16T23:04:40.523Z",
            "currency": {
              "code": "ARS",
              "locale": "es-AR",
              "symbol": "$",
              "text": "Peso Argentino"
            },
            "description": "Orden 11111111111",
            "id": "3Z6D9YF71L0LGGRR8DRT3W",
            "operation": {
              "type": "payment.v2"
            },
            "reference": "1111111111",
            "requestedCurrency": {
              "code": "ARS",
              "locale": "es-AR",
              "symbol": "$",
              "text": "Peso Argentino"
            },
            "requestedTotal": 145170,
            "riskAnalysis": {
              "band": "N/A",
              "level": "N/A"
            },
            "source": {
              "cardholder": {
                "identification": "12123123",
                "name": "Bruce Wayne"
              },
              "expiration": {
                "month": "06",
                "year": "24"
              },
              "installment": {
                "amount": 145170,
                "count": 1,
                "description": "1 Cuota",
                "reference": "1",
                "tags": [],
                "uid": "NzqWp58GA"
              },
              "name": "Visa Banco Santander",
              "number": "46600000****4601",
              "reference": "visa.santanderrio",
              "transaction": {
                "authorizationCode": "004288",
                "batchNo": "",
                "resultCode": "0",
                "retrievalReferenceNo": "410723133668",
                "ticketNo": "",
                "transactionId": "3Z6D9YF71L0LGGRR8DRT3W"
              },
              "type": "card",
              "variant": "credit"
            },
            "status": {
              "code": "200",
              "data": {},
              "message": "Transacción Aprobada",
              "resultCode": "0",
              "text": "Aprobado",
              "view": "default"
            },
            "total": 145170,
            "updated": "2024-04-16T23:04:42.146Z"
        },
        "entity": {
            "name": "Wayne Inc",
            "uid": "iambatman"
        },
        "customer": {
            "uid": "12123123",
            "name": "Juan Perez Wayne",
            "phone": "12123123",
            "identification": "110303456",
            "email": "soybatman@wayneinc.com"
        },
        "user": {
            "name": "Juan Perez Wayne",
            "email": "soybatman@wayneinc.com"
        },
        "source": {
            "name": "Visa Banco Santander",
            "reference": "visa.santanderrio",
            "type": "card"
        },
        "pos": {
            "name": "POS Nombre",
			"description": "-",
			"mode": "normal",
			"reference": "POS:MY_REF",
			"terminal": {
				"uid": "GDQ3V8L4EE6AAE5L9NWCK5",
				"reference": "ING:123AAA1235566",
				"serialNumber": "123AAA1235566"
			}
        }
    }
}
﻿
Modo de Pruebas
Para probar en el POS cree una operación con la variable "test" en true. Para poder simular los diferentes estados debe utilizar el "total" de la operación, por ejemplo si desea que la transacción se apruebe el total debe ser 200. Vea la documentación de "Códigos de Estado" para mayor detalle y posibilidades de prueba.
Luego de crear la transacción con las condiciones indicadas proceda a utilizar cualquier tarjeta real, la operación no será cobrada sino que será simulada de acuerdo a lo indicado.
Modos del Punto de Venta
Actualmente se soportan 2 modos:
Modo NORMAL: en este modo quien opera el POS puede ingresar el monto de la operación con el teclado en pantalla.
Modo ESCLAVO: en este modo el POS se transforma en un dispositivo que debe ser controlado 100% desde la API sin que el usuario pueda intervenir.
En todos los modos soportados la API aquí documentada puede ser utilizada permitiendo integrar el POS al 100% a su sistema de caja.
Updated 25 May 2024
Did this page help you?
Tokenización de Tarjetas y Cuentas Bancarias - Wallet Transparent
Marketplace y Split de pagos