🛠️ Guía de Implementación: Notificación Externa
El servicio de notificación externa de PayPhone te permite recibir automáticamente en tu Webhook el detalle de cada pago aprobado. ¡Ideal para procesar pedidos, confirmar compras y mantener tu sistema actualizado en tiempo real!
📤¿Qué se envía?
Al aprobarse un pago, Payphone te envía un JSON con toda la información relevante.
Ejemplo de JSON:
{
"Amount": 2688,
"AuthorizationCode": "W32805807",
"ClientTransactionId": "ID-UNICO-1446-3748",
"StatusCode": 3,
"TransactionStatus": "Approved",
"StoreId": "your_storeId",
"PhoneNumber": "593984111333",
"Email": "eloy@mail.com",
"CardType": "Credit",
"Bin": "409724",
"DeferredCode": "00000000",
"DeferredMessage": null,
"Deferred": false,
"CardBrandCode": "50",
"CardBrand": "Visa St Georges Bank",
"Document": "1234567890",
"Currency": "USD",
"Taxes": [],
"Reference": "Referencia de Pago",
"AdditionalData": null,
"Products": [],
"TransactionId": 32805807
}
📝Descripción de parámetros JSON enviados
Código de autorización bancario.
Identificador de transacción que enviaste en la petición.
Código de estado de la transacción.
2 = Cancelado
3 = Aprobada
Estado de la transacción (Approved o Canceled).
Identificador de la sucursal que efectúa el cobro.
Número de teléfono registrado en el pago.
El correo electrónico registrado en el pago.
Tipo de tarjeta utilizada (crédito o débito).
Primeros 6 dígitos de la tarjeta utilizada.
Código de diferido empleado por el usuario.
Indica si se usó un diferido (booleano).
Código de la marca de la tarjeta.
Número de identificación registrado en el pago.
Moneda utilizada para el pago.
Arreglo de impuestos cobrados
Motivo de la transacción.
ID de productos para Autopago
Identificador de transacción asignado por Payphone.
Se requiere que el comercio procese y almacene la información recibida en su webhook, y genere una respuesta JSON.
📩 ¿Qué se debe responder?
El webhook debe devolver una respuesta en formato JSON indicando:
Response:
Booleano indicando true
si la notificación fue recibida correctamente, o false
si ocurrió algún error.ErrorCode:
Código de error correspondiente al procesamiento de la notificación. Se utiliza para especificar qué error ocurrió (si es que hubo alguno).
✅ Notificación Recibida.
{
"Response": true,
"ErrorCode": "000"
}
❌ Notificación con algún error.
{
"Response": false,
"ErrorCode": "111"
}
📚 Catálogo de Mensajes
El catálogo de códigos de error que se puede devolver es el siguiente:
Notificación fallida: no se pudo de serializar el objeto.
Notificación fallida: Error genérico.
Notificación fallida: El número de TransactionId
ya existe.
Notificación fallida: Error en variables requeridas con valores null
o vacíos.
Notificación fallida: El StoreId
no existe.
Notificación fallida: El StoreId
está inactivo.
La implementación correcta de este proceso permite a los comercios recibir el detalle de las transacciones aprobadas en una de sus tiendas registradas.
⚠️ Recomendaciones Finales
- ✔️ Asegúrate de almacenar toda la información de cada transacción.
- ✔️ Procesa las notificaciones rápidamente para evitar reintentos.
- ✔️ Mantén tu endpoint siempre disponible y seguro 🔐.