Desarrolladores
Botón de Pago

8min
POST
Request
Header Parameters
x-api-key
required
String
Clave API de su aplicación.
x-access-token
required
String
Token de acceso a su comercio.
content-type
required
String
application/json
Body Parameters
total
required
Number
Monto de la operación. Formato XXX.xx donde el PUNTO es el separador decimal.
description
required
String
Descripción de la operación que será mostrada en el checkout al ingresar.
currency
required
String
Moneda de la operación. Valor admitido "ARS"
reference
required
String
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.
test
optional
Boolean
Permite colocar el checkout en modo test y realizar operaciones con las tarjetas de prueba. 
return_url
optional
String
URL a la cual será enviado el usuario al finalizar el pago.
webhook
optional
String
URL a la cual será informado el pago mediante WebHooks (POST)
items
optional
Array
Listado de elementos pertenecientes al cobro con checkout y que serán mostrados al ingresar al mismo como parte de la descripción del pago. Para generar un checkout asociado a una suscripción se debe configurar en este array. Ver el ejemplo sobre este nodo incluído debajo de esta documentación.
options
optional
Object
Permite definir opciones para el checkout creado.
sources
optional
Array
Permite la limitación de los medios de pago aceptados. De esta forma, en el checkout únicamente podrán utilizarse los medios aquí definidos.
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 de planes. Los ejemplos puedes encontrarlos más abajo en la documentación. 
customer
required
Object
Objeto con los datos del cliente
split
optional
Array
Permite dividir el cobro del checkout en varias entidades de Unicobros. Para más detalles ver la sección "Marketplace, Split, Cobro con Comisión".
timeout
optional
Number
Tiempo de vida en minutos del checkout durante el cual podrá ser utilizado, luego de este tiempo el checkout no tendrá validez. Por defecto son 60 minutos.
intent
optional
String
Tipo de operatoria de la operación. Ver documentación sobre operatoria en 2 pasos.
multicard
optional
Boolean
Permite abonar la operación en el checkout con múltiples tarjetas. No es compatible con operaciones de tipo SPLIT.
addresses
optional
Array
Direcciones del cliente
addresses[$].type
optional
String
Tipo de Dirección. Valores admitidos: "billing", "shipping"
addresses[$].country
optional
String
Páis. Valores admitidos: Ver Tabla de Países en Complementos.
addresses[$].street
optional
String
Dirección sin número
addresses[$].streetNumber
optional
String
Número de Puerta de la dirección
addresses[$].streetNotes
optional
String
Notas references a la dirección, segunda linea de dirección, Piso, Departamento, Oficina, etc.
addresses[$].zipCode
optional
String
Código Postal
addresses[$].city
optional
String
Ciudad
addresses[$].state
optional
String
Estado (ISO 3166). Ver Cod. de Provincias Argentinas en la sección Complementos.
webhooksType
optional
String
Permite activar o desactivar ciertos tipos de Webhooks. Por defecto esta opción será "all". Opciones posibles: "all", "none", "final", "intermediateAndFinal". Ver explicación más abajo.
multivendor
optional
String
En el caso de habilitar el modo Multivendedor, indica el tipo de operatoria "active" o "unified". Active permite el cliente pague los productos de cada vendedor con sus respectivas cuotas. Unified realiza la unificación de las cuotas comunes a todas los vendedores.
merchants
optional
Array
Requerido en operatoria de tipo Multivendedor. 
merchants.[$].uid
required
String
UID del comercio multivendedor
merchants.[$].intent
optional
String
Intención de pago de las operaciones del comercio multivendedor (aplica para casos de 2-pasos)
C#
Curl
Java
JS
Python
import requests
import json

url = "https://api.unicobros.com.ar/p/checkout"

payload = json.dumps({
  "total": "100.53",
  "description": "Checkout de Prueba",
  "reference": "260520210954",
  "currency": "ARS",
  "test": True,
  "return_url": "https://unicobros.com.ar/return_url",
  "webhook": "https://api.unicobros.com.ar/webhook",
  "customer": {
    "email": "[email protected]",
    "name": "Cliente Demo",
    "identification": "12123123"
  }
})
headers = {
  'x-api-key': 'zJ8LFTBX6Ba8D611e9io13fDZAwj0QmKO1Hn1yIj',
  'x-access-token': 'd31f0721-2f85-44e7-bcc6-15e19d1a53cc',
  'Content-Type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

import requests
import json

url = "https://api.unicobros.com.ar/p/checkout"

payload = json.dumps({
  "total": "100.53",
  "description": "Checkout de Prueba",
  "reference": "260520210954",
  "currency": "ARS",
  "test": True,
  "return_url": "https://unicobros.com.ar/return_url",
  "webhook": "https://api.unicobros.com.ar/webhook",
  "customer": {
    "email": "demo@unicobros.com",
    "name": "Cliente Demo",
    "identification": "12123123"
  }
})
headers = {
  'x-api-key': 'zJ8LFTBX6Ba8D611e9io13fDZAwj0QmKO1Hn1yIj',
  'x-access-token': 'd31f0721-2f85-44e7-bcc6-15e19d1a53cc',
  'Content-Type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)
Responses
200
404
{
    "result": true,
    "data": {
        "id": "EC27WUC5YH5MHT0J9I",
        "url": "https://sugaway.com/p/checkout/v2/EC27WUC5YH5MHT0J9I",
        "description": "Checkout de Prueba",
        "currency": "ARS",
        "total": 100.53,
        "created": 1622033797494
    }
}
{
    "result": true,
    "data": {
        "id": "EC27WUC5YH5MHT0J9I",
        "url": "https://sugaway.com/p/checkout/v2/EC27WUC5YH5MHT0J9I",
        "description": "Checkout de Prueba",
        "currency": "ARS",
        "total": 100.53,
        "created": 1622033797494
    }
}
﻿
Ejemplos del nodo sources:
JSON
{
    "sources": ["visa", "mastercard"]
}
{
    "sources": ["visa", "mastercard"]
}
﻿
Ejemplos del nodo installments:
Eisten 3 formas de Limitar Planes:
Ocultar determinados planes de todo el conjunto de planes existentes:
Estos planes se pueden oxcultar 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:
JSON
{
    "installments": ["+uid:XPDhreMoG7","+uid: ID Regla Avanzada"]
}
{
    "installments": ["+uid:XPDhreMoG7","+uid: ID Regla Avanzada"]
}
﻿
Importante
Duración del Checkout
El checkout creado sólo podrá ser utilizado por 60 ( o el tiempo definido en la variable Timeout ) minutos, luego de esto expirará. Si el cliente intenta pagar luego de este periodo será redireccionado a la url declarada en return_url con status 401 (Expirado).
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.
﻿
Retorno
Transacción Finalizada
Al definir el parámetro return_url el servicio redireccionará a la URL provista mediante HTTP Get una vez finalizada la transacción. A esta url se le agregará el Estado de la misma mediante el parámetro status, el tipo de transacción generada por el usuario mediante el parámetro type (cash/card) y el identificador de la transacción mediante el parámetro transactionId.
Ejemplo:
https://unicobros.com/thank_you?status=200&type=cash&transactionId=NfkvurRUX

Transacción Cancelada
Si el usuario cancela la operación status será 0 y type será none. Esto como se señala indica que el usuario no finalizó la operación y decidió volver al sitio.
Ejemplo:
https://unicobros.com/thank_you?status=0&type=none&transactionId=-1

﻿
Esto le permitirá eliminar un checkout creado antes de los 60 minutos de duración por defecto.
DELETE
Request
Query Parameters
ID
required
String
ID del Checkout a Eliminar.
Header Parameters
x-api-key
required
String
Clave API de su aplicación.
x-access-token
required
String
Token de Acceso a la entidad.
JS
fetch("https://api.unicobros.com.ar/p/checkout/EC27WUC5YH5MHT0J9I", {
  "method": "GET",
  "headers": {
    "Accept": "application/json",
    "x-api-key": "zJ8LFTBX6Ba8D611e9io13fDZAwj0QmKO1Hn1yIj",
    "x-access-token": "d31f0721-2f85-44e7-bcc6-15e19d1a53cc"
  }
})
.then(response => {
  console.log(response);
})
.catch(err => {
  console.error(err);
});
fetch("https://api.unicobros.com.ar/p/checkout/EC27WUC5YH5MHT0J9I", {
  "method": "GET",
  "headers": {
    "Accept": "application/json",
    "x-api-key": "zJ8LFTBX6Ba8D611e9io13fDZAwj0QmKO1Hn1yIj",
    "x-access-token": "d31f0721-2f85-44e7-bcc6-15e19d1a53cc"
  }
})
.then(response => {
  console.log(response);
})
.catch(err => {
  console.error(err);
});
Responses
200
{
    "name": "Cake's name",
}
{
    "name": "Cake's name",
}
﻿
﻿
Updated 22 Nov 2024
Did this page help you?
Canales de Atención.
Integración Embebida