Desarrolladores
Link de Pago

6min
﻿
POST
Request
Header Parameters
x-api-key
String
required
Clave API de su aplicación.
x-access-token
String
required
Token de Acceso a la entidad para la cual desea realizar la operación.
Content-Type
String
required
application/json
Body Parameters
total
Number
required
Monto de la operación. Formato XXX.xx donde el PUNTO es el separador decimal.
description
String
required
Descripción de la operación que será mostrada en la Orden de Pago.
email
String
optional
El email al cual será enviada la orden de pago generada. Si no se provee se usa el teléfono o se retorna la URL.
phone
String
optional
Número de Celular al cual será enviada la Orden Generada. Si no se provee se usa email o se retorna la URL. El número debe ingresarse sin 0 y sin 15.
reference
String
optional
Factura, Recibo o referencia del pago a Realizar. Puede ser un identificador de un sistema externo para seguimiento. Este Identificador pertenece a su sistema pero debe ser único para cada operación. Unicobros no permite 2 operaciones en estado Pago con el mismo reference.
due
Object
optional
Fecha de vencimiento de la Orden. Formato: day, month, year
due.day
Number
required
Día de vencimiento de la orden.
due.month
Number
required
Mes de vencimiento de la orden.
due.year
Number
required
Año de vencimiento de la orden.
secondDue
Object
optional
Segundo vencimiento de la Orden.
secondDue.days
Number
required
Días al segundo vencimiento pasado el primer vencimiento.
secondDue.surcharge
Number
required
Recargo adicional a cobrarse en el segundo vencimiento respecto al total original de la orden.
actions
Array
optional
Acciones mostradas en la descripción del pago a realizar. Este parámetro es un array y puede contener 1 o varias acciones.
return_url
String
optional
URL a la cual será enviado el usuario al finalizar el pago.
webhook
String
optional
URL a la cual será informado el pago mediante WebHooks ( POST )
intent
String
optional
Tipo de operatoria de la operación. Ver documentación sobre operatoria en 2 pasos.
items
Array
optional
Elementos que serán mostrados al ingresar a la orden de pago como parte de la descripción del pago.
options
Object
optional
Otras opciones de personalización de la orden
options.smsMessage
String
optional
Mensaje a incluirse en el SMS enviado al cliente antes del link de la orden. El largo máximo para el parámetro smsMessage es de 140 caractéres.
options.theme
Object
optional
Le permite personalizar su Experiencia de Cobro. Para más detalles ver la sección "Personalización de la UI de Pago".
sources
Array
optional
Permite la limitación de los medios de pago aceptados. De esta forma, en la orden de pago únicamente podrán utilizarse los medios aquí definidos.
installments
Array
optional
Permite la limitación de los Planes Activos al pagar la orden. Para realizar dicha limitación se debe enviar un array de referencias de planes. Se definen ejemplos a continuación.
customerForm
String
optional
Permite utilizar un formulario diseñado desde Mobbex. Para configurar este campo anteponer "custom:" al ID del Formulario generado. Ej "custom:45uZCRY09".
test
Boolean
optional
Activa/Desactiva el modo de pruebas. En este modo es posible utilizar las Tarjetas de Prueba definidas en esta documentación. Valor por defecto: false
split
Array
optional
Permite dividir el cobro de la orden en varias entidades de Unicobros. Para más detalles ver la sección "Marketplace, Split, Cobro con Comisión".
customer
Object
optional
Objeto con los datos del cliente
customer.email
String
required
Email del Cliente. Este parametro es Necesario.
customer.identification
String
required
DNI del cliente.
customer.name
String
required
Nombre del cliente.
customer.phone
String
optional
Teléfono del cliente.
customer.{field}
Object
optional
Puede colocar información sobre su cliente en este objeto. El objeto Customer no debe superar los 20kb en total.
multicard
Boolean
optional
Permite abonar la operación en el link de pago con múltiples tarjetas. No es compatible con operaciones de tipo SPLIT.
type
String
optional
Permite generar un Link de Pago Cerrado o Abierto. En el caso del Link de Pago Abierto el cliente podrá pagar lo que desee. Valores admitidos: "open" o "closed". Si no se envía se toma "closed" por defecto
Curl
JS
PHP
Python
Shell
curl -X POST \
  https://napi.mobbex.com/p/payment_order \
  -H 'Content-Type: application/json' \
  -H 'cache-control: no-cache' \
  -H 'x-access-token: d31f0721-2f85-44e7-bcc6-15e19d1a53cc' \
  -H 'x-api-key: zJ8LFTBX6Ba8D611e9io13fDZAwj0QmKO1Hn1yIj' \
  -H 'x-lang: es' \
  -d '{
    "total": 100,
    "description": "Some Description #3",
    "due": {
      "day": 18,
      "month": 4,
      "year": 2021
    },
    "secondDue":{
        "days": 10,
        "surcharge": 30
    },
    "actions": [
        {
            "icon": "attachment",
            "title": "Factura",
            "url": "https://speryans.com/mifactura/123",
        },
    ],
    "return_url": "https://unicobros.com/order123/return",
    "webhook": "https://unicobros.com/order123/webhook",
    "reference": "mi_referencia_123",
    "options":{
        "smsMessage": "Enviamos la orden generada para su pago"
    }
}'
curl -X POST \
  https://napi.mobbex.com/p/payment_order \
  -H 'Content-Type: application/json' \
  -H 'cache-control: no-cache' \
  -H 'x-access-token: d31f0721-2f85-44e7-bcc6-15e19d1a53cc' \
  -H 'x-api-key: zJ8LFTBX6Ba8D611e9io13fDZAwj0QmKO1Hn1yIj' \
  -H 'x-lang: es' \
  -d '{
    "total": 100,
    "description": "Some Description #3",
    "due": {
      "day": 18,
      "month": 4,
      "year": 2021
    },
    "secondDue":{
        "days": 10,
        "surcharge": 30
    },
    "actions": [
        {
            "icon": "attachment",
            "title": "Factura",
            "url": "https://speryans.com/mifactura/123",
        },
    ],
    "return_url": "https://unicobros.com/order123/return",
    "webhook": "https://unicobros.com/order123/webhook",
    "reference": "mi_referencia_123",
    "options":{
        "smsMessage": "Enviamos la orden generada para su pago"
    }
}'
Responses
200
{
    "result": true,
    "data": {
        "uid": "JlwOU4dzj",
        "secondDueSurcharge": 0,
        "sources": [],
        "installments: [],
        "reference": "mi_referencia_123",
        "return_url": "",
        "webhook": "",
        "emailSubject: "",
        "test": false,
        "customerForm": "default",
        "description": "Orden de Pago con 1 Vencimiento",
        "email": "",
        "currency": "ARS",
        "creator": null,
        "app": "5761a3dd8aad6c120042b287",
        "phone": "",
        "dueDate": "2019-12-25T00:00:00.000Z",
        "secondDueDate": null,
        "created": "2020-11-18T18:43:17.412Z",
        "url": "http://unicobros.com/p/payment_order/XXXXXX",
        "qr": "",
        "total": 100,
    }
}
{
    "result": true,
    "data": {
        "uid": "JlwOU4dzj",
        "secondDueSurcharge": 0,
        "sources": [],
        "installments: [],
        "reference": "mi_referencia_123",
        "return_url": "",
        "webhook": "",
        "emailSubject: "",
        "test": false,
        "customerForm": "default",
        "description": "Orden de Pago con 1 Vencimiento",
        "email": "",
        "currency": "ARS",
        "creator": null,
        "app": "5761a3dd8aad6c120042b287",
        "phone": "",
        "dueDate": "2019-12-25T00:00:00.000Z",
        "secondDueDate": null,
        "created": "2020-11-18T18:43:17.412Z",
        "url": "http://unicobros.com/p/payment_order/XXXXXX",
        "qr": "",
        "total": 100,
    }
}
﻿
Ejemplos del nodo actions:
JSON
"actions": [
    {
        "icon": "document",
        "title": "Factura",
        "url": "https://unicobros.com/mifactura/123"
    },
    {
        "icon": "attachment",
        "title": "Factura 2",
        "url": "https://unicobros.com/mifactura/1234"
    }
]
"actions": [
    {
        "icon": "document",
        "title": "Factura",
        "url": "https://unicobros.com/mifactura/123"
    },
    {
        "icon": "attachment",
        "title": "Factura 2",
        "url": "https://unicobros.com/mifactura/1234"
    }
]
﻿
Ejemplos del nodo items:
JSON
{
    "items": [
        {
            "image": "https://www.unicobros.com/wp-content/uploads/2019/03/web_logo.png",
            "quantity": 2,
            "description": "Mi Producto",
            "total": 50
        }
    ]
}
{
    "items": [
        {
            "image": "https://www.unicobros.com/wp-content/uploads/2019/03/web_logo.png",
            "quantity": 2,
            "description": "Mi Producto",
            "total": 50
        }
    ]
}
﻿
Las imágenes deben soportar HTTPS, de lo contrario no serán mostradas.
Ejemplos del nodo sources:
JSON
{
    "sources": ["visa", "mastercard"]
}
{
    "sources": ["visa", "mastercard"]
}
﻿
Ejemplos del nodo installments:
Existen 3 formas de limitar los planes en base a su reference:
Limitar los Planes únicamente a los elegidas en el Array:
JSON
{
    "installments": ["1", "3", "ahora_12"]
}
{
    "installments": ["1", "3", "ahora_12"]
}
﻿
Ocultar determinados planes de todo el conjunto de planes existentes:
JSON
{
    "installments": ["-ahora_12", "-ahora_18"]
}
{
    "installments": ["-ahora_12", "-ahora_18"]
}
﻿
Atributo "reference"
Este atributo es utilizado para evitar pagos duplicados. Debe ser único para cada operación de pago a identificar, ya que Unicobros NO permitirá 2 transacciones en estado "Pago" con el mismo reference.
﻿
Esta API permite reenviar la orden de pago a través de email o teléfono definido en la misma
POST
Request
Header Parameters
x-api-key
String
required
Clave API de su aplicación.
x-access-token
String
required
Token de acceso del comercio
Body Parameters
id
String
required
Identificador (UID) de la orden de pago.
JS
var data = JSON.stringify({
    id: "JlwOU4dzj"
});

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
    if (this.readyState === 4) {
        console.log(this.responseText);
    }
});

xhr.open("POST", "https://api.unicobros.com.ar/p/payment_order/resend");
xhr.setRequestHeader("x-api-key", "zJ8LFTBX6Ba8D611e9io13fDZAwj0QmKO1Hn1yIj");
xhr.setRequestHeader("x-access-token", "d31f0721-2f85-44e7-bcc6-15e19d1a53cc");
xhr.setRequestHeader("x-lang", "es");
xhr.setRequestHeader("Content-Type", "application/json");
xhr.setRequestHeader("cache-control", "no-cache");

xhr.send(data);
var data = JSON.stringify({
    id: "JlwOU4dzj"
});

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
    if (this.readyState === 4) {
        console.log(this.responseText);
    }
});

xhr.open("POST", "https://api.unicobros.com.ar/p/payment_order/resend");
xhr.setRequestHeader("x-api-key", "zJ8LFTBX6Ba8D611e9io13fDZAwj0QmKO1Hn1yIj");
xhr.setRequestHeader("x-access-token", "d31f0721-2f85-44e7-bcc6-15e19d1a53cc");
xhr.setRequestHeader("x-lang", "es");
xhr.setRequestHeader("Content-Type", "application/json");
xhr.setRequestHeader("cache-control", "no-cache");

xhr.send(data);
Responses
200
{}
{}
﻿
DELETE
Request
Query Parameters
ID
String
required
Identificador (UID) de la orden de pago a eliminar.
Header Parameters
x-api-key
String
required
Clave API de su aplicación.
x-access-token
String
required
Token de acceso del comercio
JS
var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
    if (this.readyState === 4) {
        console.log(this.responseText);
    }
});

xhr.open("DELETE", "https://api.unicobros.com.ar/p/payment_order/JlwOU4dzj");
xhr.setRequestHeader("x-api-key", "zJ8LFTBX6Ba8D611e9io13fDZAwj0QmKO1Hn1yIj");
xhr.setRequestHeader("x-access-token", "d31f0721-2f85-44e7-bcc6-15e19d1a53cc");
xhr.setRequestHeader("x-lang", "es");
xhr.setRequestHeader("Content-Type", "application/json");
xhr.setRequestHeader("cache-control", "no-cache");

xhr.send();
var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
    if (this.readyState === 4) {
        console.log(this.responseText);
    }
});

xhr.open("DELETE", "https://api.unicobros.com.ar/p/payment_order/JlwOU4dzj");
xhr.setRequestHeader("x-api-key", "zJ8LFTBX6Ba8D611e9io13fDZAwj0QmKO1Hn1yIj");
xhr.setRequestHeader("x-access-token", "d31f0721-2f85-44e7-bcc6-15e19d1a53cc");
xhr.setRequestHeader("x-lang", "es");
xhr.setRequestHeader("Content-Type", "application/json");
xhr.setRequestHeader("cache-control", "no-cache");

xhr.send();
Responses
200
{
    "result": true
}
{
    "result": true
}
﻿
POST
Request
Path Params
ID
String
required
ID de la orden de pago a marcar como paga
Header Parameters
x-api-key
String
required
Clave API de su aplicación.
x-access-token
String
required
Token de acceso a la entidad
Curl
JS
curl --location --request POST 'https://api.unicobros.com.ar/p/payment_order/JlwOU4dzj/paid' \
--header 'x-api-key: zJ8LFTBX6Ba8D611e9io13fDZAwj0QmKO1Hn1yIj' \
--header 'x-access-token: d31f0721-2f85-44e7-bcc6-15e19d1a53cc'
curl --location --request POST 'https://api.unicobros.com.ar/p/payment_order/JlwOU4dzj/paid' \
--header 'x-api-key: zJ8LFTBX6Ba8D611e9io13fDZAwj0QmKO1Hn1yIj' \
--header 'x-access-token: d31f0721-2f85-44e7-bcc6-15e19d1a53cc'
Responses
200
404
{
    "result": true,
    "view": {
        "type": "none"
    },
    "payment": {
        "id": "IGev250cR",
        "description": "Orden de Pago con 1 Vencimiento",
        "operation": {
            "type": "manual"
        },
        "status": {
            "code": "200",
            "text": "Aprobado",
            "message": ""
        },
        "total": 100,
        "currency": {
            "code": "ARS",
            "text": "Peso Argentino",
            "symbol": "$"
        },
        "riskAnalysis": {
            "band": "N/A",
            "level": "N/A"
        },
        "created": "2021-05-28T13:54:37.978Z",
        "updated": "2021-05-28T13:54:37.986Z",
        "reference": "mi_referencia_123"
    },
    "user": {
        "name": "",
        "email": ""
    }
}
{
    "result": true,
    "view": {
        "type": "none"
    },
    "payment": {
        "id": "IGev250cR",
        "description": "Orden de Pago con 1 Vencimiento",
        "operation": {
            "type": "manual"
        },
        "status": {
            "code": "200",
            "text": "Aprobado",
            "message": ""
        },
        "total": 100,
        "currency": {
            "code": "ARS",
            "text": "Peso Argentino",
            "symbol": "$"
        },
        "riskAnalysis": {
            "band": "N/A",
            "level": "N/A"
        },
        "created": "2021-05-28T13:54:37.978Z",
        "updated": "2021-05-28T13:54:37.986Z",
        "reference": "mi_referencia_123"
    },
    "user": {
        "name": "",
        "email": ""
    }
}
﻿
﻿
Integración Embebida
Devoluciones