Consulta de Operaciones y Childs

6 min

Consultar Transacción por UID

Esta API permite consultar el estado de la transacción por el ID de cupón o referencia.

GET

https://api.sugaway.com/p/operations/{UID}

curl --request POST \
  --url https://api.mobbex.com/2.0/transactions/status \
  --header 'cache-control: no-cache' \
  --header 'content-type: multipart/form-data; \
  --header 'x-api-key: zJ8LFTBX6Ba8D611e9io13fDZAwj0QmKO1Hn1yIj' \
  --header 'x-access-token: d31f0721-2f85-44e7-bcc6-15e19d1a53cc' \
  --form 'id=#MyImportantID'

Ejemplo de nodo childs:

 "childs": [
                {
                    "id": "675ae372aa48b839b789144f",
                    "uid": "CHD-727BJJJVN8FAC1UZLV",
                    "operation": "payment.v2",
                    "status": "200",
                    "card_number": "45079900****0010",
                    "source": {
                        "name": "Visa Débito",
                        "reference": "visa.debit"
                    },
                    "installment_count": 1,
                    "total": 400.53,
                    "currency": "TEST",
                    "description": "Checkout de Prueba",
                    "reference": "02G3GROO2VP5N2ANE8",
                    "user": {
                        "name": "Cliente Demo",
                        "email": "[email protected]"
                    },
                    "updated": "2024-12-12T13:24:22.602Z",
                    "created": "2024-12-12T13:21:54.377Z"
                },
                {
                    "id": "675ae372aa48b839b7891457",
                    "uid": "CHD-R3I5VC9H0KV4GDE0QK",
                    "operation": "payment.v2",
                    "status": "200",
                    "card_number": "45079831****2450",
                    "source": {
                        "name": "Visa",
                        "reference": "visa"
                    },
                    "installment_count": 1,
                    "total": 500,
                    "currency": "TEST",
                    "description": "Checkout de Prueba",
                    "reference": "949MFIFCZM77505MKK",
                    "user": {
                        "name": "Cliente Demo",
                        "email": "[email protected]"
                    },
                    "updated": "2024-12-12T13:22:06.791Z",
                    "created": "2024-12-12T13:21:54.377Z"
                }
            ]

Aclaración: El ejemplo anterior corresponde a una transacción que se abonó con dos medios de pago distintos, generando un CHD por cada medio de pago.

Listado y Búsqueda de Transacciones

Mediante la siguiente API se puede obtener un listado de operaciones en Suga y ejecutar diferentes filtros sobre ellas.

GET

https://api.sugaway.com/p/entity/operations?page={page}&limit={limit}

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

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

xhr.open("GET", "https://api.mobbex.com/p/operations?page=0&limit=20&reference=my_mobbex_reference&context=plugin.value.checkout:web,plugin.value.payment_order:web,&test=true");
xhr.setRequestHeader("x-api-key", "zJ8LFTBX6Ba8D611e9io13fDZAwj0QmKO1Hn1yIj");
xhr.setRequestHeader("x-access-token", "d31f0721-2f85-44e7-bcc6-15e19d1a53cc");

xhr.send();

Formato del objeto created/updated en consultas de tipo POST:

{
  "from: {
    "day": 10,
    "month": 11,
    "year": 2019
  },
  "to": {
    "day": 11,
    "month": 11,
    "year": 2019
  }
}

Tipos de Contextos

Checkout: plugin.value.checkout:web ,plugin.value.checkout:button
Links de Venta: plugin.value.commerce:buy
Códigos de Barra de Pago: plugin.value.payment_code:generate
Orden de pago: plugin.value.payment_order:web
MultiPOS: plugin.value.pos:web, plugin.value.pos:web.mobile, plugin.value.pos:mobile, plugin.value.pos:desktop
Suscripciones: plugin.value.subscriptions:subscribe, plugin.value.subscriptions:exec

Estados de la Transacción:

Para mayor información sobre los posibles estados de una transacción para su filtrado, remitirse a Estados y Tipos de Transacción. Es muy importante revisar la documentación sobre estados y tipos de transacción ya que el manejo de los mismos será utilizado durante la homologación del comercio.

Código QR de Transacción

El código QR generado por Mobbex en las transacciones y enviado a través de Email y Tickets puede ser utilizado para obtener fácilmente el código de la misma y mediante nuestra API consultar el detalle de la Transacción.

Utilización del Código QR.

Leer el código QR utilizando un lector de códigos estandar
Separar el código utilizando el caracter: :
El primer segmento del QR separado será el ID de la transacción
Utilizando el ID de la transacción Consultar el Estado de la misma en nuestro API.

Ejemplo de Código QR

MYpmTQlVC:kYSmcGx1Z2lusHBsdWdpbi52YWx1ZS5wb3OjdWlkrm1vYmJleC53ZWIucG9zpGRhdGHZMHsidXNlciI6IjU3NmQyOTEzYzM0YzY0MTIwMDI1OTU2YSIsInR5cGUiOiJ3ZWIifaNfaWSCqV9ic29udHlwZahPYmplY3RJRKJpZMQMXP3Z3uPhOxJEzKZ5

Código Separado

MYpmTQlVC: Código de Operación
kYSmcGx1Z2lusHBsdWdpbi52YWx1ZS5wb3OjdWlkrm1vYmJleC53ZWIucG9zpGRhdGHZMHsidXNlciI6IjU3NmQyOTEzYzM0YzY0MTIwMDI1OTU2YSIsInR5cGUiOiJ3ZWIifaNfaWSCqV9ic29udHlwZahPYmplY3RJRKJpZMQMXP3Z3uPhOxJEzKZ5: Datos internos de la Operación