Consulta de Operaciones y childs

3 min

Consultar Transacción por UID o referencia

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

GET

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

Path Parameters

uidstringrequired
Description
Identificador del cupón a solicitar.
REF:string
Description
Referencia del cupón a solicitar.

Header Parameters

x-api-keystringrequired
Description
Clave API de su aplicación.
x-access-tokenstringrequired
Description
Token de Acceso a la entidad

curl

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'

javascript

var data = new FormData();
data.append("id", "#MyImportantID");
var xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function () {
    if (this.readyState === 4) {
        console.log(this.responseText);
    }
});
xhr.open("POST", "https://api.mobbex.com/2.0/transactions/status");
xhr.setRequestHeader("x-api-key", "zJ8LFTBX6Ba8D611e9io13fDZAwj0QmKO1Hn1yIj");
xhr.setRequestHeader("x-access-token", "d31f0721-2f85-44e7-bcc6-15e19d1a53cc");
xhr.setRequestHeader("cache-control", "no-cache");
xhr.send(data);

php

<?php
$request = new HttpRequest();
$request->setUrl('https://api.mobbex.com/2.0/transactions/status');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders(array(
  'cache-control' => 'no-cache',
  'content-type' => 'application/json',
  'x-access-token' => 'd31f0721-2f85-44e7-bcc6-15e19d1a53cc',
  'x-api-key' => 'zJ8LFTBX6Ba8D611e9io13fDZAwj0QmKO1Hn1yIj'
));
$request->setPostFields(array(
  'id' => '#MyImportantID'
));
try {
  $response = $request->send();
  echo $response->getBody();
} catch (HttpException $ex) {
  echo $ex;
}
?>

200

{
    "result": true,
    "data": {
        "transactions": [
            {
                "_id": "5f0c97f616d2da0eb6d68943",
                "uid": "OmM7j3LSzb",
                "utid": "",
                "status": "200",
                "description": "Checkout Demo",
                "message": "",
                "type": "Payment",
                "total": 100.5,
                "references": [],
                "hash": "",
                "sender": "5e283b0a49fb2b1a71dad7d8",
                "receiver": "58485bda80471d000f9e0fc9",
                "coupon": "5f0c97f616d2da0eb6d6893f",
                "currency": {
                    "value": "TEST",
                    "label": "Test Money",
                    "symbol": "T$",
                    "hidden": false
                },
                "updated": "2020-07-13T17:20:54.463Z",
                "created": "2020-07-13T17:20:54.462Z",
                "__v": 0
            }
        ],
        "transaction": {
            "result": true,
            "view": {
                "type": "card"
            },
            "payment": {
                "id": "zP5_3fqSt",
                "description": "Checkout Demo",
                "operation": {
                    "type": "payment.v2"
                },
                "status": {
                    "code": "200",
                    "text": "Aprobado",
                    "message": "Transacción Aprobada"
                },
                "total": 100.5,
                "currency": {
                    "code": "TEST",
                    "text": "Test Money",
                    "symbol": "T$"
                },
                "riskAnalysis": {
                    "band": "N/A",
                    "level": "N/A"
                },
                "created": "2020-07-13T17:20:54.308Z",
                "updated": "2020-07-13T17:20:54.977Z",
                "reference": "Referencia Demo",
                "source": {
                    "name": "Visa Débito",
                    "type": "card",
                    "reference": "visa.debit",
                    "number": "450799******0010",
                    "expiration": {
                        "month": "12",
                        "year": "25"
                    },
                    "installment": {
                        "description": "Debito",
                        "amount": 100.5,
                        "count": 1,
                        "reference": "1_debit"
                    }
                }
            },
            "user": {
                "name": "Cliente Demo",
                "email": "[email protected]"
            },
            "source": {
                "name": "Visa Débito",
                "type": "card",
                "reference": "visa.debit"
            }
        },
        "transaction_details": [
            {
                "key": "card_number",
                "label": "Número de Tarjeta",
                "value": "450799******0010"
            },
            {
                "key": "transactionId",
                "label": "ID Transacción",
                "value": "zP5_3fqSt"
            },
            {
                "key": "authorizationCode",
                "label": "Código de Autorización",
                "value": "121212"
            },
            {
                "key": "ticketNo",
                "label": "Número de Ticket",
                "value": "1111"
            }
        ]
    }
}

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"
                }
            ]

Listado y Búsqueda de Transacciones

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

GET

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

Query Parameters

pageIntegerrequired
Description
Número de página para paginación. El valor comienza en 0.
limitInteger
Description
Límite de transacciones a devolver. Default: 15. Máximo: 50
statusNumber
Description
Estado de la transacción (código).
currencyString
Description
Moneda de la Transacción: Admitidos: ARS, TEST.
created_fromstring
Description
Fecha de creación de la operación. Desde cuando buscar. Fecha como String o Timestamp en milisegundos.
created_tostring
Description
Fecha de creación de la operación. Hasta cuando buscar. Fecha como String o Timestamp en milisegundos.
textstring
Description
Buscar texto en las operaciones.
referencestring
Description
Referencia asociada a la Operación.
testBoolean
Description
Permite obtener sólo operaciones de prueba.
contextstring
Description
Permite filtrar el contexto de la operación. String separado por coma sin espacios.
updated_fromstring
Description
Fecha de actualización de la operación. Desde cuando buscar. Fecha como String o Timestamp.
updated_tostring
Description
Fecha de actualización de la Operación. Hasta cuando buscar. Fecha como String o Timestamp.

Header Parameters

x-api-keystringrequired
Description
Clave API de su aplicación.
x-access-tokenstringrequired
Description
Token de acceso de la entidad.

javascript

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/entity/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();

php

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://api.mobbex.com/p/entity/operations?page=0&limit=20&reference=my_mobbex_reference&context=plugin.value.checkout:web,plugin.value.payment_order:web&test=true',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => array(
    'x-api-key: zJ8LFTBX6Ba8D611e9io13fDZAwj0QmKO1Hn1yIj',
    'x-access-token: d31f0721-2f85-44e7-bcc6-15e19d1a53cc'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

200

{
    "result": true,
    "data": {
        "docs": [
            {
                "_id": "606f01cc063b6c569b7cb232",
                "user": {
                    "name": "demo"
                },
                "uid": "GZF5JBMBd",
                "operation": "payment.v2",
                "status": "200",
                "sourceReference": "mastercard",
                "sourceName": "Mastercard",
                "installmentReference": "1",
                "card_number": "532362******1008",
                "description": "Orden Test",
                "reference": "my_mobbex_reference",
                "riskQualityLevel": 0,
                "entity": {
                    "_id": "5761a3dd8aad6c120042b287",
                    "name": "Demo",
                    "uid": "H1rJEXyr",
                    "tax_id": "99999999999"
                },
                "total": 2871.74,
                "totals": {
                    "total": 2871.74,
                    "user_charges": 0,
                    "entity_charges": {
                        "source": 0,
                        "installment": 0,
                        "service": 0
                    },
                    "currency": "TEST",
                    "installment_amount": 2871.74,
                    "financial": {
                        "percentage": 0,
                        "amount": 0
                    },
                    "requested": {
                        "total": 2871.74,
                        "currency": "TEST"
                    },
                    "currency_data": {
                        "value": "TEST",
                        "label": "Test Money",
                        "symbol": "T$",
                        "hidden": false
                    },
                    "installment": {
                        "amount": 2871.74,
                        "count": 1
                    }
                },
                "created": "2021-04-08T13:14:52.648Z",
                "context": {
                    "value": "plugin.value.payment_order:web",
                    "name": "Orden de Pago"
                },
                "intent": {
                    "value": "payment.v2",
                    "name": "Pago"
                },
                "source": {
                    "name": "Mastercard",
                    "reference": "mastercard"
                },
                "sign": "+",
                "riskQuality": {
                    "level": 0,
                    "band": 0
                }
            },
            {
                "_id": "606f0073799a6056ca9cd0ba",
                "user": {
                    "name": "Demo"
                },
                "uid": "4ED9NVAHM",
                "operation": "payment.v2",
                "status": "400",
                "sourceReference": "mastercard",
                "sourceName": "Mastercard",
                "installmentReference": "1",
                "card_number": "532362******1008",
                "description": "Orden Test",
                "reference": "my_mobbex_reference",
                "riskQualityLevel": 0,
                "entity": {
                    "_id": "5761a3dd8aad6c120042b287",
                    "name": "Demo",
                    "uid": "H1rJEXyr",
                    "tax_id": "99999999999"
                },
                "total": 2871.74,
                "totals": {
                    "total": 2871.74,
                    "user_charges": 0,
                    "entity_charges": {
                        "source": 0,
                        "installment": 0,
                        "service": 0
                    },
                    "currency": "TEST",
                    "installment_amount": 2871.74,
                    "financial": {
                        "percentage": 0,
                        "amount": 0
                    },
                    "requested": {
                        "total": 2871.74,
                        "currency": "TEST"
                    },
                    "currency_data": {
                        "value": "TEST",
                        "label": "Test Money",
                        "symbol": "T$",
                        "hidden": false
                    },
                    "installment": {
                        "amount": 2871.74,
                        "count": 1
                    }
                },
                "created": "2021-04-08T13:09:07.404Z",
                "context": {
                    "value": "plugin.value.payment_order:web",
                    "name": "Orden de Pago"
                },
                "intent": {
                    "value": "payment.v2",
                    "name": "Pago"
                },
                "source": {
                    "name": "Mastercard",
                    "reference": "mastercard"
                },
                "sign": "+",
                "riskQuality": {
                    "level": 0,
                    "band": 0
                }
            }
        ],
        "page": 1,
        "prevPage": -1,
        "nextPage": -1,
        "limit": 20
    }
}

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.