Desarrolladores
Consulta de Operaciones y childs
3min
Esta API permite consultar el estado de la transacción por el ID de cupón.
POST
Request
Header Parameters
x-api-key
required
String
Clave API de su aplicación.
x-access-token
required
String
Token de Acceso a la entidad
Body Parameters
id
required
String
Identificador del cupón a solicitar.
Curl
JS
PHP
1<?php
2$request = new HttpRequest();
3$request->setUrl('https://api.unicobros.com.ar/2.0/transactions/status');
4$request->setMethod(HTTP_METH_POST);
5$request->setHeaders(array(
6 'cache-control' => 'no-cache',
7 'content-type' => 'application/json',
8 'x-access-token' => 'd31f0721-2f85-44e7-bcc6-15e19d1a53cc',
9 'x-api-key' => 'zJ8LFTBX6Ba8D611e9io13fDZAwj0QmKO1Hn1yIj'
10));
11$request->setPostFields(array(
12 'id' => '#MyImportantID'
13));
14try {
15 $response = $request->send();
16 echo $response->getBody();
17} catch (HttpException $ex) {
18 echo $ex;
19}
20?>
Responses
200
1{
2 "result": true,
3 "data": {
4 "transactions": [
5 {
6 "_id": "5f0c97f616d2da0eb6d68943",
7 "uid": "OmM7j3LSzb",
8 "utid": "",
9 "status": "200",
10 "description": "Checkout Demo",
11 "message": "",
12 "type": "Payment",
13 "total": 100.5,
14 "references": [],
15 "hash": "",
16 "sender": "5e283b0a49fb2b1a71dad7d8",
17 "receiver": "58485bda80471d000f9e0fc9",
18 "coupon": "5f0c97f616d2da0eb6d6893f",
19 "currency": {
20 "value": "TEST",
21 "label": "Test Money",
22 "symbol": "T$",
23 "hidden": false
24 },
25 "updated": "2020-07-13T17:20:54.463Z",
26 "created": "2020-07-13T17:20:54.462Z",
27 "__v": 0
28 }
29 ],
30 "transaction": {
31 "result": true,
32 "view": {
33 "type": "card"
34 },
35 "payment": {
36 "id": "zP5_3fqSt",
37 "description": "Checkout Demo",
38 "operation": {
39 "type": "payment.v2"
40 },
41 "status": {
42 "code": "200",
43 "text": "Aprobado",
44 "message": "Transacción Aprobada"
45 },
46 "total": 100.5,
47 "currency": {
48 "code": "TEST",
49 "text": "Test Money",
50 "symbol": "T$"
51 },
52 "riskAnalysis": {
53 "band": "N/A",
54 "level": "N/A"
55 },
56 "created": "2020-07-13T17:20:54.308Z",
57 "updated": "2020-07-13T17:20:54.977Z",
58 "reference": "Referencia Demo",
59 "source": {
60 "name": "Visa Débito",
61 "type": "card",
62 "reference": "visa.debit",
63 "number": "450799******0010",
64 "expiration": {
65 "month": "12",
66 "year": "25"
67 },
68 "installment": {
69 "description": "Debito",
70 "amount": 100.5,
71 "count": 1,
72 "reference": "1_debit"
73 }
74 }
75 },
76 "user": {
77 "name": "Cliente Demo",
78 "email": "[email protected]"
79 },
80 "source": {
81 "name": "Visa Débito",
82 "type": "card",
83 "reference": "visa.debit"
84 }
85 },
86 "transaction_details": [
87 {
88 "key": "card_number",
89 "label": "Número de Tarjeta",
90 "value": "450799******0010"
91 },
92 {
93 "key": "transactionId",
94 "label": "ID Transacción",
95 "value": "zP5_3fqSt"
96 },
97 {
98 "key": "authorizationCode",
99 "label": "Código de Autorización",
100 "value": "121212"
101 },
102 {
103 "key": "ticketNo",
104 "label": "Número de Ticket",
105 "value": "1111"
106 }
107 ]
108 }
109}
La siguiente URL listará todas las transacciones o cupones generados para el pago solicitado mediante la misma referencia junto con sus estados. Esta API devuelve detalle de las Childs cuando corresponda.
GET
Request
Query Parameters
reference
required
String
Referencia de la factura o pago solicitado.
Header Parameters
x-api-key
required
String
Clave API de su aplicación.
x-access-token
required
String
Token de Acceso a la entidad
Curl
JS
PHP
1curl --request GET \
2 --url https://api.unicobros.com.ar/2.0/transactions/coupons/mi_referencia_0101 \
3 --header 'cache-control: no-cache' \
4 --header 'x-api-key: zJ8LFTBX6Ba8D611e9io13fDZAwj0QmKO1Hn1yIj' \
5 --header 'x-access-token: d31f0721-2f85-44e7-bcc6-15e19d1a53cc'
Responses
200
1{
2 "result": true, //Resultado de la consulta
3 "data": [ //Devuelve un Object Array
4 {
5 "id": "606f057c063b6c569b7cb3a7", //ID interno del Coupon.
6 "uid": "IkKr5G~aG", //ID de la operación.
7 "operation": "payment.v2", //Método de pago.
8 "status": "200", // Código de estado de la transacción.
9 "source": { //Forma de pago.
10 "name": "Visa Débito", //Nombre de: Medios de Pago.
11 "reference": "visa.debit" //Medio de pago.
12 },
13 "installment_count": 1, //Cantidad de cuotas.
14 "total": 10288, //Monto total cobrado.
15 "currency": "TEST", //Tipo de moneda.
16 "description": "Pago Demo",//Descripción personalizada del pago.
17 "reference": "81_202104081029249199", //Referencia personalizada del pago.
18 "user": {
19 "name": "Demo Unicobros", //Nombre del usuario que compró
20 "email": "[email protected]" //Correo del usuario que compró.
21 },
22 "updated": "2021-04-08T13:30:36.570Z", //Fecha de cobro.
23 "created": "2021-04-08T13:30:36.470Z" //Fecha de creación.
24 }
25 ]
26}
Ejemplo de nodo childs:
JSON
1 "childs": [
2 {
3 "id": "675ae372aa48b839b789144f",
4 "uid": "CHD-727BJJJVN8FAC1UZLV",
5 "operation": "payment.v2",
6 "status": "200",
7 "card_number": "45079900****0010",
8 "source": {
9 "name": "Visa Débito",
10 "reference": "visa.debit"
11 },
12 "installment_count": 1,
13 "total": 400.53,
14 "currency": "TEST",
15 "description": "Checkout de Prueba",
16 "reference": "02G3GROO2VP5N2ANE8",
17 "user": {
18 "name": "Cliente Demo",
19 "email": "[email protected]"
20 },
21 "updated": "2024-12-12T13:24:22.602Z",
22 "created": "2024-12-12T13:21:54.377Z"
23 },
24 {
25 "id": "675ae372aa48b839b7891457",
26 "uid": "CHD-R3I5VC9H0KV4GDE0QK",
27 "operation": "payment.v2",
28 "status": "200",
29 "card_number": "45079831****2450",
30 "source": {
31 "name": "Visa",
32 "reference": "visa"
33 },
34 "installment_count": 1,
35 "total": 500,
36 "currency": "TEST",
37 "description": "Checkout de Prueba",
38 "reference": "949MFIFCZM77505MKK",
39 "user": {
40 "name": "Cliente Demo",
41 "email": "[email protected]"
42 },
43 "updated": "2024-12-12T13:22:06.791Z",
44 "created": "2024-12-12T13:21:54.377Z"
45 }
46 ]
Mediante la siguiente API se puede obtener un listado de operaciones en Unicobros y ejecutar diferentes filtros sobre ellas.
GET
Request
Query Parameters
page
required
Integer
Número de página para paginación. El valor comienza en 0.
limit
optional
Integer
Límite de transacciones a devolver. Default: 15. Máximo: 50
status
optional
Number
Estado de la transacción (código).
currency
optional
String
Moneda de la Transacción: Admitidos: ARS, TEST.
created_from
optional
String
Fecha de creación de la operación. Desde cuando buscar. Fecha como String o Timestamp.
created_to
optional
String
Fecha de creación de la operación. Hasta cuando buscar. Fecha como String o Timestamp.
text
optional
String
Buscar texto en las operaciones.
reference
optional
String
Referencia asociada a la Operación.
test
optional
Boolean
Permite obtener sólo operaciones de prueba.
context
optional
String
Permite filtrar el contexto de la operación. String separado por coma sin espacios.
updated_from
optional
String
Fecha de actualización de la operación. Desde cuando buscar. Fecha como String o Timestamp.
updated_to
optional
String
Fecha de actualización de la Operación. Hasta cuando buscar. Fecha como String o Timestamp.
Header Parameters
x-api-key
required
String
Clave API de su aplicación.
x-access-token
required
String
Token de acceso de la entidad.
JS
PHP
1<?php
2
3$curl = curl_init();
4
5curl_setopt_array($curl, array(
6 CURLOPT_URL => 'https://api.unicobros.com.ar/p/operations?page=0&limit=20&reference=my_mobbex_reference&context=plugin.value.checkout:web,plugin.value.payment_order:web&test=true',
7 CURLOPT_RETURNTRANSFER => true,
8 CURLOPT_ENCODING => '',
9 CURLOPT_MAXREDIRS => 10,
10 CURLOPT_TIMEOUT => 0,
11 CURLOPT_FOLLOWLOCATION => true,
12 CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
13 CURLOPT_CUSTOMREQUEST => 'GET',
14 CURLOPT_HTTPHEADER => array(
15 'x-api-key: zJ8LFTBX6Ba8D611e9io13fDZAwj0QmKO1Hn1yIj',
16 'x-access-token: d31f0721-2f85-44e7-bcc6-15e19d1a53cc'
17 ),
18));
19
20$response = curl_exec($curl);
21
22curl_close($curl);
23echo $response;
24
Responses
200
1{
2 "result": true,
3 "data": {
4 "docs": [
5 {
6 "_id": "606f01cc063b6c569b7cb232",
7 "user": {
8 "name": "demo"
9 },
10 "uid": "GZF5JBMBd",
11 "operation": "payment.v2",
12 "status": "200",
13 "sourceReference": "mastercard",
14 "sourceName": "Mastercard",
15 "installmentReference": "1",
16 "card_number": "532362******1008",
17 "description": "Orden Test",
18 "reference": "my_mobbex_reference",
19 "riskQualityLevel": 0,
20 "entity": {
21 "_id": "5761a3dd8aad6c120042b287",
22 "name": "Demo",
23 "uid": "H1rJEXyr",
24 "tax_id": "99999999999"
25 },
26 "total": 2871.74,
27 "totals": {
28 "total": 2871.74,
29 "user_charges": 0,
30 "entity_charges": {
31 "source": 0,
32 "installment": 0,
33 "service": 0
34 },
35 "currency": "TEST",
36 "installment_amount": 2871.74,
37 "financial": {
38 "percentage": 0,
39 "amount": 0
40 },
41 "requested": {
42 "total": 2871.74,
43 "currency": "TEST"
44 },
45 "currency_data": {
46 "value": "TEST",
47 "label": "Test Money",
48 "symbol": "T$",
49 "hidden": false
50 },
51 "installment": {
52 "amount": 2871.74,
53 "count": 1
54 }
55 },
56 "created": "2021-04-08T13:14:52.648Z",
57 "context": {
58 "value": "plugin.value.payment_order:web",
59 "name": "Orden de Pago"
60 },
61 "intent": {
62 "value": "payment.v2",
63 "name": "Pago"
64 },
65 "source": {
66 "name": "Mastercard",
67 "reference": "mastercard"
68 },
69 "sign": "+",
70 "riskQuality": {
71 "level": 0,
72 "band": 0
73 }
74 },
75 {
76 "_id": "606f0073799a6056ca9cd0ba",
77 "user": {
78 "name": "Demo"
79 },
80 "uid": "4ED9NVAHM",
81 "operation": "payment.v2",
82 "status": "400",
83 "sourceReference": "mastercard",
84 "sourceName": "Mastercard",
85 "installmentReference": "1",
86 "card_number": "532362******1008",
87 "description": "Orden Test",
88 "reference": "my_mobbex_reference",
89 "riskQualityLevel": 0,
90 "entity": {
91 "_id": "5761a3dd8aad6c120042b287",
92 "name": "Demo",
93 "uid": "H1rJEXyr",
94 "tax_id": "99999999999"
95 },
96 "total": 2871.74,
97 "totals": {
98 "total": 2871.74,
99 "user_charges": 0,
100 "entity_charges": {
101 "source": 0,
102 "installment": 0,
103 "service": 0
104 },
105 "currency": "TEST",
106 "installment_amount": 2871.74,
107 "financial": {
108 "percentage": 0,
109 "amount": 0
110 },
111 "requested": {
112 "total": 2871.74,
113 "currency": "TEST"
114 },
115 "currency_data": {
116 "value": "TEST",
117 "label": "Test Money",
118 "symbol": "T$",
119 "hidden": false
120 },
121 "installment": {
122 "amount": 2871.74,
123 "count": 1
124 }
125 },
126 "created": "2021-04-08T13:09:07.404Z",
127 "context": {
128 "value": "plugin.value.payment_order:web",
129 "name": "Orden de Pago"
130 },
131 "intent": {
132 "value": "payment.v2",
133 "name": "Pago"
134 },
135 "source": {
136 "name": "Mastercard",
137 "reference": "mastercard"
138 },
139 "sign": "+",
140 "riskQuality": {
141 "level": 0,
142 "band": 0
143 }
144 }
145 ],
146 "page": 1,
147 "prevPage": -1,
148 "nextPage": -1,
149 "limit": 20
150 }
151}
Mediante la siguiente API se puede obtener un listado de operaciones en Unicobros y ejecutar diferentes filtros sobre ellas.
POST
Request
Query Parameters
page
required
String
Número de página para paginación. El valor comienza en 0.
limit
optional
String
Límite de transacciones a devolver. Default: 15. Máximo: 50
Header Parameters
x-api-key
required
String
Clave API de su aplicación
x-access-token
required
String
Token de acceso al comercio
content-type
required
String
application/json
Body Parameters
status
optional
String
Estado de la transacción (código).
currency
optional
String
Moneda de la Transacción: Admitidos: ARS, TEST.
created
optional
Object
Objeto con la fecha de creación de la operación.
updated
optional
Object
Objeto con la fecha de actualización de la operación.
text
optional
String
Buscar texto en las operaciones.
reference
optional
String
Referencia asociada a la Operación.
context
optional
Array
Permite filtrar el contexto de la operación. Array de Strings de los contextos a filtrar.
JS
PHP
1<?php
2
3$curl = curl_init();
4
5curl_setopt_array($curl, array(
6 CURLOPT_URL => 'https://api.unicobros.com.ar/p/operations?page=0&limit=20',
7 CURLOPT_RETURNTRANSFER => true,
8 CURLOPT_ENCODING => '',
9 CURLOPT_MAXREDIRS => 10,
10 CURLOPT_TIMEOUT => 0,
11 CURLOPT_FOLLOWLOCATION => true,
12 CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
13 CURLOPT_CUSTOMREQUEST => 'POST',
14 CURLOPT_POSTFIELDS =>'{
15 "reference": "my_mobbex_reference",
16 "context": ["plugin.value.checkout:web", "plugin.value.payment_order:web"],
17 "test": true
18}',
19 CURLOPT_HTTPHEADER => array(
20 'x-api-key: zJ8LFTBX6Ba8D611e9io13fDZAwj0QmKO1Hn1yIj',
21 'x-access-token: d31f0721-2f85-44e7-bcc6-15e19d1a53cc',
22 'Content-Type: application/json'
23 ),
24));
25
26$response = curl_exec($curl);
27
28curl_close($curl);
29echo $response;
30
Responses
200
1{
2 "result": true,
3 "data": {
4 "docs": [
5 {
6 "_id": "606f01cc063b6c569b7cb232",
7 "user": {
8 "name": "demo"
9 },
10 "uid": "GZF5JBMBd",
11 "operation": "payment.v2",
12 "status": "200",
13 "sourceReference": "mastercard",
14 "sourceName": "Mastercard",
15 "installmentReference": "1",
16 "card_number": "532362******1008",
17 "description": "Orden Test",
18 "reference": "my_unicobros_reference",
19 "riskQualityLevel": 0,
20 "entity": {
21 "_id": "5761a3dd8aad6c120042b287",
22 "name": "Demo",
23 "uid": "H1rJEXyr",
24 "tax_id": "99999999999"
25 },
26 "total": 2871.74,
27 "totals": {
28 "total": 2871.74,
29 "user_charges": 0,
30 "entity_charges": {
31 "source": 0,
32 "installment": 0,
33 "service": 0
34 },
35 "currency": "TEST",
36 "installment_amount": 2871.74,
37 "financial": {
38 "percentage": 0,
39 "amount": 0
40 },
41 "requested": {
42 "total": 2871.74,
43 "currency": "TEST"
44 },
45 "currency_data": {
46 "value": "TEST",
47 "label": "Test Money",
48 "symbol": "T$",
49 "hidden": false
50 },
51 "installment": {
52 "amount": 2871.74,
53 "count": 1
54 }
55 },
56 "created": "2021-04-08T13:14:52.648Z",
57 "context": {
58 "value": "plugin.value.payment_order:web",
59 "name": "Orden de Pago"
60 },
61 "intent": {
62 "value": "payment.v2",
63 "name": "Pago"
64 },
65 "source": {
66 "name": "Mastercard",
67 "reference": "mastercard"
68 },
69 "sign": "+",
70 "riskQuality": {
71 "level": 0,
72 "band": 0
73 }
74 },
75 {
76 "_id": "606f0073799a6056ca9cd0ba",
77 "user": {
78 "name": "Demo"
79 },
80 "uid": "4ED9NVAHM",
81 "operation": "payment.v2",
82 "status": "400",
83 "sourceReference": "mastercard",
84 "sourceName": "Mastercard",
85 "installmentReference": "1",
86 "card_number": "532362******1008",
87 "description": "Orden Test",
88 "reference": "my_mobbex_reference",
89 "riskQualityLevel": 0,
90 "entity": {
91 "_id": "5761a3dd8aad6c120042b287",
92 "name": "Demo",
93 "uid": "H1rJEXyr",
94 "tax_id": "99999999999"
95 },
96 "total": 2871.74,
97 "totals": {
98 "total": 2871.74,
99 "user_charges": 0,
100 "entity_charges": {
101 "source": 0,
102 "installment": 0,
103 "service": 0
104 },
105 "currency": "TEST",
106 "installment_amount": 2871.74,
107 "financial": {
108 "percentage": 0,
109 "amount": 0
110 },
111 "requested": {
112 "total": 2871.74,
113 "currency": "TEST"
114 },
115 "currency_data": {
116 "value": "TEST",
117 "label": "Test Money",
118 "symbol": "T$",
119 "hidden": false
120 },
121 "installment": {
122 "amount": 2871.74,
123 "count": 1
124 }
125 },
126 "created": "2021-04-08T13:09:07.404Z",
127 "context": {
128 "value": "plugin.value.payment_order:web",
129 "name": "Orden de Pago"
130 },
131 "intent": {
132 "value": "payment.v2",
133 "name": "Pago"
134 },
135 "source": {
136 "name": "Mastercard",
137 "reference": "mastercard"
138 },
139 "sign": "+",
140 "riskQuality": {
141 "level": 0,
142 "band": 0
143 }
144 }
145 ],
146 "page": 1,
147 "prevPage": -1,
148 "nextPage": -1,
149 "limit": 20
150 }
151}
Formato del objeto created/updated en consultas de tipo POST:
JSON
1{
2 "from: {
3 "day": 10,
4 "month": 11,
5 "year": 2019
6 },
7 "to": {
8 "day": 11,
9 "month": 11,
10 "year": 2019
11 }
12}
Updated 13 Dec 2024
Did this page help you?