Pasos para implementar una cancelación.
En caso de requerirlo, se puede cancelar una venta realizada el mismo día consumiendo el servicio de cancelación.
Para realizar una cancelación, es necesario contar con la siguiente información:
Nota.
- La terminal debe tener acceso a internet en todo momento sin restricciones al dominio y subdominios *.netpay.com.mx para recibir y enviar solicitudes.
- Debe estar encendida la pantalla de la terminal y estar en primer plano la pantalla principal de la aplicación.
- Sólo se puede cancelar una transacción realizada el mismo día, y la cancelación se debe solicitar antes de las 20:00 hora Ciudad de México por el monto total.
6.1 Estructura de una petición.
POST https://api-154.api-netpay.com/integration-service/transactions/cancel
Headers
Los siguientes headers deben ser enviados en la petición
- Content-Type: application/json
- Authorization: Bearer {{access_token}}
6.2 Estructura de un JSON de cancelación.
Para realizar una cancelación, es necesario contar con la siguiente información.
| Parámetro. | Descripción. |
|---|---|
| serialNumber | Número de serie. Cadena numérica a 10 dígitos ubicada en la parte posterior de la terminal (S/N). |
| storeId | Número identificador de comercio asignado por terminal. |
| access_token | Token de acceso necesario para consumir el servicio. Ver sección Generar Token. |
| orderId | Número de orden generado al realizar una venta. Ver información de Recibiendo la respuesta. |
| traceability | Objeto JSON para enviar información relevante para el comercio (Opcional). |
| disablePrintAnimation | Bandera de control con valor por default false. Al enviarla en true, se omitirá el ticket oficial de NetPay. (Opcional.) |
Body
En la petición, se debe mandar un objeto JSON con los datos según se requieran.
{
"traceability": {},
"serialNumber": "{serialNumber}",
"orderId": "{orderId}",
"storeId": "{storeId}",
"disablePrintAnimation": true
}
Nota.
Los 3 valores mínimos requeridos son serialNumber, orderId, storeId.
6.3 Ejemplo de solicitud / respuesta.
A continuación, se muestran ejemplos en diferentes lenguajes de programación para realizar una petición y solicitar una cancelación.