APIs Giftcards
- Elizabeth Rivera Lazcano (Unlicensed)
Analytics
Documentación de servicios para PagosVarios/Gift Cards
Mobile GiftCard Service
GiftCardTransactionController
Controller
GiftCardTransactionController
Métodos | Parámetros de entrada | Parámetro de salida | URL | Detalles |
|---|---|---|---|---|
|
|
|
| Endpoint que permite a la aplicacion mobile conectarse con el CORE para la comprar de una gift card |
Ejemplo peticiones
giftcardPurchaseTransaction
Petición
Ejemplo de parámetros de entrada
{
"priceId": "GLf2OTSSj5tckDuOmgSyEZ6RETNbq@kskRHYrcDmveg=",
"upc": "799366545682",
"amount": 20000,
"userId": "68385c22-00bd-49c7-9f07-e77a7814566e",
"providerName": "Google",
"providerId": "638747510af87b3f929cabab",
"productName": "MX InComm Test TV Dummy Product DDP 200 MXN"
}Respuesta de petición existosa
{
"transactionId": "string",
"userId": "string",
"relatedTransactionId": "string",
"customerNumber": "string",
"accountNumber": "string,
"createdAt": "date",
"transactionType": "string",
"amount": integer,
"commission": double,
"tax": double,
"taxPercentage": double
}GiftCard Service
GiftCardTransactionController
Controller
GiftCardTransactionController
Métodos | Parámetros de entrada | Parámetro de salida | URL | Detalles |
|---|---|---|---|---|
|
|
|
| Endpoint del CORE que realiza el proceso para la compra de una gift card, abarca transacción con Fiserv e Incomm |
| --- |
|
| Endpoint para el listado de las transacciones que conllevan las compras de gift cards, aplica filtros de userId, transactionId, fecha de inicio y fin |
Ejemplo peticiones
buyGiftCard
Petición
Ejemplo de parámetros de entrada
{
"transferTransactionId": "639201148fd0d150c130ab90a",
"userId": "24551f65-6948-4871-9f23-3d40d3c853d6",
"personalInfoDTO": {
"firstName": "Anna Sofia",
"lastNameP": "Kubacsek",
"lastNameM": "Carsolio",
"phone": "+51973347642",
"email": "jose.napa@oxxofintech.com.mx",
"gender": "female",
"dateOfBirth": "1995-05-22"
},
"priceId": "GLf2OTSSj5tckDuOmgSyEZ6RETNbq@kskRHYrcDmveg=",
"productName": "MX InComm Test TV Dummy Product DDP 200 MXN",
"upc": "799366545682",
"amount": 20000,
"providerId": "638747510af87b3f929cabab",
"providerName": "Google"
}Respuesta de petición existosa
listGiftCard
Petición
Ejemplo de petición
Respuesta de petición existosa
Incomm Gateway Service
RtgDigitalController
RetailInCommService
RtgDigitalController
Controller
RtgDigitalController
Dependencias
com.oxxo.fintech.incomm.service.RetailInCommService
Métodos | Parámetros de entrada | Parámetro de salida | URL | Detalles |
|---|---|---|---|---|
|
|
|
| La url se encuentra en el archivo de constantes |
|
|
|
| La url se encuentra en el archivo de constantes |
|
|
|
| La url se encuentra en el archivo de constantes |
Diagrama del Proceso de Cancelación
Ejemplo peticiones
requestActiveCode
Petición
Ejemplo de parámetros de entrada
Respuesta de petición existosa
returnActiveCode
Petición
Ejemplo de parámetros de entrada
Respuesta de petición existosa
cancel
Petición
Ejemplo de parámetros de entrada
Respuesta de petición existosa
RetailInCommService
Controller
RetailInCommService
Dependencias
com.oxxo.fintech.incomm.client.IncommRetrofitClient
com.oxxo.fintech.incomm.config.IncommConfig
Métodos | Parámetros de entrada | Detalle | Parámetros de salida | Detalle | Descripción |
|---|---|---|---|---|---|
|
| Objeto que se espera del controlador y que será convertida al objeto de la petición para los servicios Incomm |
| Objeto que se regresa a la petición del controlador y que es un objeto convertido del objeto de respuesta de los servicios de Incomm | Este método sirve como intermediario entre el servicio de |
|
| Petición que se espera del controlador y que será convertida al objeto de la petición para los servicios Incomm |
| Objeto que se regresa a la petición del controlador y que es un objeto convertido del objeto de respuesta de los servicios de Incomm | Este método sirve como intermediario entre el servicio de |
|
| Petición que se espera del controlador y que será convertida al objeto de la petición para los servicios Incomm |
| Objeto que se regresa a la petición del controlador y que es un objeto convertido del objeto de respuesta de los servicios de Incomm | Este método sirve como intermediario entre el servicio de |
Cliente Retrofit
Es una implementación de un cliente rest usado por Spin el cual permite consumir servicios rest y que posee una configuración por defecto el cual permite realizar loggeo de las url, cuerpo de peticiones y cuerpo de respuestas de las peticiones realizadas.
IncommRetrofitClient
Controller
IncommRetrofitClient
Dependencias
com.oxxo.fintech.incomm.client.IncommRepository
Método | Parámetros de entrada | Detalle | Parámetros de salida | Detalle | Descripción |
|---|---|---|---|---|---|
|
| Objeto para realizar la petición al servicio |
| Objeto de respuesta de consumo del servicio
| Realiza la ejecución del llamado a la petición rest |
|
| Objeto para realizar la petición al servicio |
| Objeto de respuesta de consumo del servicio
| Realiza la ejecución del llamado a la petición rest |
|
| Objeto para realizar la petición al servicio cancel de Incomm |
| Objeto de respuesta de consumo del servicio cancel de Incomm | Realiza la ejecución del llamado a la petición rest |
|
| Objeto que contiene la respuesta del cliente Retrofit
Objeto de manejo de error al realizar las peticiones | void | --- | Este método intercepta la respuesta de cada llamado realizado en los métodos anteriores, llamados a los servicios de Incomm, y en caso de haber respuesta con error, se encarga de formatear la respuesta. |
| --- | --- |
| Objeto que sirve para controlar el error que pueda surgir durante las llamadas a los servicios de Incomm | Método sobrecargado que se encarga de interceptar los errores y enviarlos con un objeto personalizado de errores. |
Ejemplo peticiones
validateResponse
Ejemplo de error formateado