--- title: Webhooks slug: webhooks description: Learn how to utilize webhooks in Mobbex to receive real-time transaction notifications via HTTP POST. This comprehensive document provides examples of webhook content for various services within Mobbex, such as Checkout, Payment Orders, and Subscriptions. docTags: createdAt: 2021-01-25T20:24:19.000Z --- # Qué es un Webbook Un webhook es un mecanismo mediante el cual Unicobros será capaz de notificar mediante HTTP POST a su servidor cuando una transacción sea realizada o cambie de estado, así usted podrá tomar las acciones necesarias en su sistema al efecto de reflejar el nuevo estado de una operación. # Servicios que soportan Webhooks - **Checkout** - **Ordenes de Pago** - **Suscripciones** ### Datos especiales - *Checkout*: Checkout agregará al final del Objeto "data" un nodo con tu información personalizada, tal como el ID de Checkout - *Subscription*: El módulo de Suscripciones agregará información sobre la suscripción, suscriptor y ejecución al final del Objeto "data". - *Órdenes de Pago*: El módulo Ordenes de Pago no agrega datos adicionales. ### Consideraciones Especiales Para poder utilizar el servicio de Webhooks, la plataforma destino debera soportar cifrado TLS 1.2 en adelante, no debiendo soportar las versiones 1.1 y anteriores. # Ejemplo de Contenido enviado en un WebHook Simple ****** ***Headers*** `Content-Type`: application/json ### Ejemplo de Contenido enviado en un WebHook Simple Pago con Código de Barra ```json { "type": "checkout", "data": { "result": true, "view": { "type": "cash", "options": { "barcode": true } }, "payment": { "id": "xcnAQ5dDO", "description": "Venta de producto", "operation": { "type": "payment.v2" }, "status": { "code": "2", "text": "En Espera", "message": "El cupón vence en 24hs." }, "total": 1333, "currency": { "code": "TEST", "text": "Test Money", "symbol": "T$" }, "riskAnalysis": { "band": "N/A", "level": "N/A" }, "created": "2020-12-04T00:08:45.604Z", "updated": "2020-12-04T00:08:46.154Z", "reference": "29", "source": { "name": "Rapipago/PagoFácil", "type": "cash", "reference": "arg_unicobros_cash", "barcode": "044715261462012050133300000000000000000000515003571363", "url": "https://utils.mobbex.com/barcode/044715261462012050133300000000000000000000515003571363?bcid=interleaved2of5&includetext=1&textxalign=center&textsize=11" } }, "entity": { "name": "Wayne Inc", "uid": "iambatman" }, "customer": { "uid": "12123123", "name": "Juan Perez Wayne", "phone": "12123123", "identification": "110303456", "email": "soybatman@wayneinc.com" }, "user": { "name": "Juan Perez Wayne", "email": "soybatman@wayneinc.com" }, "source": { "name": "Rapipago/PagoFácil", "type": "cash", "reference": "arg_unicobros_cash" }, "checkout": { "uid": "TK0L70HEE9M4T6EBPH" } } } ``` ### Ejemplo de Contenido enviado en un WebHook de Checkout ```json { "data": { "checkout": { "currency": "ARS", "total": 145170, "uid": "CHK:UOUIOWAM3NU1BE19WB" }, "customer": { "email": "iam@batman.com", "identification": "12123123", "name": "Bruce Wayne", "phone": "+541122334455", "uid": "48186e4f-8bda-4d0f-95e1-430d89a187ef" }, "entity": { "name": "DEMO S.A.", "uid": "123LRVRtO" }, "ipAddress": "192.228.17.57", "payment": { "created": "2024-04-16T23:04:40.523Z", "currency": { "code": "ARS", "locale": "es-AR", "symbol": "$", "text": "Peso Argentino" }, "description": "Orden 11111111111", "id": "3Z6D9YF71L0LGGRR8DRT3W", "operation": { "type": "payment.v2" }, "reference": "1111111111", "requestedCurrency": { "code": "ARS", "locale": "es-AR", "symbol": "$", "text": "Peso Argentino" }, "requestedTotal": 145170, "riskAnalysis": { "band": "N/A", "level": "N/A" }, "source": { "cardholder": { "identification": "12123123", "name": "Bruce Wayne" }, "expiration": { "month": "06", "year": "24" }, "installment": { "amount": 145170, "count": 1, "description": "1 Cuota", "reference": "1", "tags": [], "uid": "NzqWp58GA" }, "name": "Visa Banco Santander", "number": "46600000****4601", "reference": "visa.santanderrio", "transaction": { "authorizationCode": "004288", "batchNo": "", "resultCode": "0", "retrievalReferenceNo": "410723133668", "ticketNo": "", "transactionId": "3Z6D9YF71L0LGGRR8DRT3W" }, "type": "card", "variant": "credit" }, "status": { "code": "200", "data": {}, "message": "Transacción Aprobada", "resultCode": "0", "text": "Aprobado", "view": "default" }, "total": 145170, "updated": "2024-04-16T23:04:42.146Z" }, "result": true, "source": { "name": "Visa Banco Santander", "reference": "visa.santanderrio", "type": "card" }, "user": { "email": "iam@batman.com", "name": "Bruce Wayne" }, "view": { "type": "card" } }, "type": "checkout" } ``` ### Ejemplo de Contenido enviado en un Webhook de Checkout con items tipo suscripción ```json { "type": "checkout", "data": { "result": true, "view": { "type": "card" }, "payment": { "id": "ABC1234", "description": "Mi Descripción", "operation": { "type": "payment.v2" }, "status": { "code": "200", "text": "Aprobado", "message": "Transacción Aprobada" }, "total": 1564.33, "currency": { "code": "ARS", "text": "Peso Argentino", "symbol": "$" }, "riskAnalysis": { "band": "red", "level": 7.1 }, "created": "2020-12-04T21:27:26.348Z", "updated": "2020-12-04T21:27:28.280Z", "reference": "external_reference", "source": { "cardholder": { "identification": "12123123", "name": "Demo" }, "expiration": { "month": "12", "year": "34" }, "installment": { "amount": 10, "count": 1, "description": "Débito", "reference": "1" }, "name": "Visa Débito", "number": "450799******0010", "reference": "visa.debit", "transaction": { "authorizationCode": "462515385471", "batchNo": "", "resultCode": "0", "retrievalReferenceNo": "", "ticketNo": "258570348489", "transactionId": "CHD-E0ECYCAI5EI5DXRA6K" }, "type": "card" } }, "entity": { "name": "Wayne Inc", "uid": "iambatman" }, "customer": { "uid": "12123123", "name": "Juan Perez Wayne", "phone": "12123123", "identification": "110303456", "email": "soybatman@wayneinc.com" }, "source": { "name": "Visa", "type": "card", "reference": "visa" }, "checkout": { "uid": "TK0L70HEE9M4T6EBPH", "total": 140.00, "currency": "ARS" }, "subscriptions": [ { "subscription": "uid_subscription", "subscriber": "uid_subscriber" } ] } } ``` ### Ejemplo de Contenido enviado en un WebHook de Suscripciones ```json { "type": "subscription:execution", "data": { "result": true, "view": { "type": "card" }, "payment": { "id": "ABC1234", "description": "Mi Descripción", "operation": { "type": "payment.v2" }, "status": { "code": "200", "text": "Aprobado", "message": "Transacción Aprobada" }, "total": 1564.33, "currency": { "code": "ARS", "text": "Peso Argentino", "symbol": "$" }, "riskAnalysis": { "band": "red", "level": 7.1 }, "created": "2020-12-04T21:27:26.348Z", "updated": "2020-12-04T21:27:28.280Z", "reference": "external_reference", "source": { "cardholder": { "identification": "12123123", "name": "Demo" }, "expiration": { "month": "12", "year": "34" }, "installment": { "amount": 10, "count": 1, "description": "Débito", "reference": "1" }, "name": "Visa Débito", "number": "450799******0010", "reference": "visa.debit", "transaction": { "authorizationCode": "462515385471", "batchNo": "", "resultCode": "0", "retrievalReferenceNo": "", "ticketNo": "258570348489", "transactionId": "CHD-E0ECYCAI5EI5DXRA6K" }, "type": "card" } }, "entity": { "name": "Wayne Inc", "uid": "iambatman" }, "customer": { "uid": "12123123", "name": "Juan Perez Wayne", "phone": "12123123", "identification": "110303456", "email": "soybatman@wayneinc.com" }, "source": { "name": "Visa", "type": "card", "reference": "visa" }, "subscription": { "uid": "CBA33333", "interval": "1m", "limit": 0, "name": "El nombre de mi suscripción", "description": "La descripción de mi suscripción", "reference": "my_reference", "total": 1564.33 }, "subscriber": { "uid": "OFF1233", "reference": "my_ref", "period": 4, "customer": { "name": "Juan Perez Wayne", "phone": "12123123", "identification": "110303456", "email": "soybatman@wayneinc.com" } }, "execution": { "uid": "RBCNXGNTJ8N2JV4R63" } } } ``` # Webhooks Especiales Tipo de Operatoria - Split - Split Distribuído - Split Híbrido - Multicard - Multi-Vendor En estos casos adicionalmente a la información standard enviada en un Webhook se enviarán las Transacciones Hijas de la operación principal bajo el campo "childs" ```json { "data": { "checkout": { "currency": "ARS", "total": 10, "uid": "CHK:42DQ1HJT7ZGU6O38JQ" }, "childs": [ { "entity": { "name": "Mi Ready", "uid": "myready" }, "payment": { "id": "CHD-E0ECYCAI5EI5DXRA6K", "source": { "cardholder": { "identification": "12123123", "name": "Demo" }, "expiration": { "month": "12", "year": "34" }, "installment": { "amount": 10, "count": 1, "description": "Débito", "reference": "1" }, "name": "Visa Débito", "number": "450799******0010", "reference": "visa.debit", "transaction": { "authorizationCode": "462515385471", "batchNo": "", "resultCode": "0", "retrievalReferenceNo": "", "ticketNo": "258570348489", "transactionId": "CHD-E0ECYCAI5EI5DXRA6K" }, "type": "card" }, "status": { "code": "200", "data": {}, "message": "Transacción Aprobada", "resultCode": "0", "text": "Aprobado", "view": "default" }, "total": 10 }, "source": { "name": "Visa Débito", "reference": "visa.debit", "type": "card" }, "view": { "type": "card" } } ], "customer": { "email": "demo@mobbex.com", "identification": "12123123", "name": "Demo Mobbex" }, "entity": { "name": "Mi Ready", "uid": "myready" }, "payment": { "created": "2023-01-06T00:25:49.358Z", "currency": { "code": "TEST", "locale": "es", "symbol": "T$", "text": "Test Money" }, "description": "Descripción de la Venta", "id": "GEQUU3V5AFNFN28DP73ESD", "operation": { "type": "payment.multiple-sources" }, "reference": "ref_test_multicheckout_9", "riskAnalysis": { "band": "N/A", "level": "N/A" }, "source": { "cardholder": {}, "expiration": { "month": "", "year": "" }, "installment": { "amount": 0, "count": 1, "description": "1", "reference": "" }, "name": "multicard", "number": "", "reference": "multicard", "transaction": { "authorizationCode": "", "batchNo": "", "resultCode": "", "retrievalReferenceNo": "", "ticketNo": "", "transactionId": "GEQUU3V5AFNFN28DP73ESD" }, "type": "card" }, "status": { "code": "200", "data": {}, "message": "Transacción Aprobada", "resultCode": -1, "text": "Aprobado", "view": "default" }, "total": 10, "updated": "2023-01-06T00:26:26.681Z" }, "result": true, "source": { "name": "multicard", "reference": "multicard", "type": "card" }, "user": { "email": "demo@unicobros.com", "name": "Demo unicobros" }, "view": { "type": "card" } }, "type": "checkout" } ```