Documentación de servicios para PagosVarios/Gift Cards
Mobile GiftCard ServiceAnchor
GiftCardTransactionController
Controller
GiftCardTransactionController
Métodos | Parámetros de entrada | Parámetro de salida | URL | Detalles |
---|---|---|---|---|
giftcardPurchaseTransaction | com.oxxo.fintech.mobile.giftcard.dto.request.GiftCardPurchaseRequestChannelDTO | com.oxxo.fintech.mobile.giftcard.dto.response.GiftCardPurchaseResponseChannelDTO | {host}/mobile/giftcard-service/giftcards/transactions | 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 ServiceAnchor
GiftCardTransactionController
Controller
GiftCardTransactionController
Métodos | Parámetros de entrada | Parámetro de salida | URL | Detalles |
---|---|---|---|---|
buyGiftCard | com.oxxo.fintech.core.dto.giftcard.request.GiftCardTransactionRequestDTO | com.oxxo.fintech.core.dto.giftcard.response.GiftCardTransactionResponseDTO | {host}/giftcard-service/transactions/buy | Endpoint del CORE que realiza el proceso para la compra de una gift card, abarca transacción con Fiserv e Incomm |
listGiftCard | --- | LIST com.oxxo.fintech.giftcard.model.GiftcardTransaction | {host}/giftcard-service/transactions ?userId={value} &transferTransactionId={value} &startDate={YYYY-MM-DD} &endDate={YYYY-MM-DD} | 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
{
"id": "639247086ab2d81ce5f0d993",
"userId": "24551f65-6948-4871-9f23-3d40d3c853d6",
"transferTransactionId": "639201148fd0d150c130ab90a",
"product": {
"name": "MX InComm Test TV Dummy Product DDP 200 MXN",
"upc": "799366545682",
"amount": 20000,
"balance": 0.0,
"status": "A"
},
"provider": {
"id": "638747510af87b3f929cabab",
"name": "Google",
"logo": "/null"
},
"status": "SUCCESS",
"traceId": "8922e1febc2c7308",
"createdAt": "2022-12-08T20:20:24.162Z"
}listGiftCard
Petición
Ejemplo de petición
{host}/giftcard-service/transactions
?userId=68385c22-00bd-49c7-9f07-e77a7814566e
&transferTransactionId=639247193ad2ce170b57d586
&startDate=2022-12-06
&endDate=2022-12-06Respuesta de petición existosa
[
{
"id": "638e4c7bac38b162e4454354",
"userId": "68385c22-00bd-49c7-9f07-e77a7814566e",
"transferTransactionId": "638e4c777134e13e75a46f85",
"traceId": "5fae2c3338fc35c8",
"createdAt": "2022-12-05T19:54:35.235Z",
"updatedAt": "2022-12-05T19:54:35.235Z"
},
{
"id": "638e52a6a97bfb76d9b7ecb7",
"userId": "68385c22-00bd-49c7-9f07-e77a7814566e",
"transferTransactionId": "638e52a27134e13e75a46f86",
"traceId": "5fae54d669589d37",
"createdAt": "2022-12-05T20:20:54.225Z",
"updatedAt": "2022-12-05T20:20:54.225Z"
}
]Incomm Gateway ServiceAnchor
RtgDigitalController
RetailInCommService
RtgDigitalControllerAnchor
Controller
RtgDigitalController
Dependencias
com.oxxo.fintech.incomm.service.RetailInCommService
Métodos | Parámetros de entrada | Parámetro de salida | URL | Detalles |
---|---|---|---|---|
requestActiveCode | com.oxxo.fintech.core.dto.gateway.request.RetailTransactionDigitalRequestGatewayDTO | com.oxxo.fintech.core.dto.gateway.response.IncommGatewayResponseDTO | /rtgdigital/requestactivecode | La url se encuentra en el archivo de constantes com.oxxo.fintech.core.constants.IncommGatewayServiceURIConstants |
returnActiveCode | com.oxxo.fintech.core.dto.gateway.request.RetailTransactionDigitalRequestGatewayDTO | com.oxxo.fintech.core.dto.gateway.response.IncommGatewayResponseDTO | /rtgdigital/returnactivecode | La url se encuentra en el archivo de constantes com.oxxo.fintech.core.constants.IncommGatewayServiceURIConstants |
cancel | com.oxxo.fintech.core.dto.gateway.request.RetailTransactionDigitalRequestGatewayDTO | com.oxxo.fintech.core.dto.gateway.response.IncommGatewayResponseDTO | /rtgdigital/cancel | La url se encuentra en el archivo de constantes com.oxxo.fintech.core.constants.IncommGatewayServiceURIConstants |
Diagrama del Proceso de Cancelación
Ejemplo peticiones
requestActiveCode
Petición
Ejemplo de parámetros de entrada
{
"transactionId":"e491e9b4-8bc8-49b3-957a-2074df3161b7-a23dc",
"amount":200.00,
"upc":"799366545682"
}Respuesta de petición existosa
{
"authID": "1318733921",
"responseCode": "0",
"responseText": "Success",
"transactionID": "e491e9b4-8bc8-49b3-957a-2074df3161b7-a23dc",
"product": {
"balance": 200.0,
"amount": 200.0,
"status": "A",
"code": "1F8LHZHHM3UVC1T8",
"metafields": {
"metafield": [
{
"name": "ddpId",
"value": "1680169056"
},
{
"name": "prodType",
"value": "pin_realtime"
},
{
"name": "serialNum",
"value": "8401331927"
}
]
}
}
}returnActiveCode
Petición
Ejemplo de parámetros de entrada
{
"transactionId":"e491e9b4-8bc8-49b3-957a-2074df3161b7-a298d",
"amount":200.00,
"upc":"799366545682",
"code": "1F8LHZHHM3UVC1T8"
}Respuesta de petición existosa
{
"authID": "1318733925",
"responseCode": "0",
"responseText": "Success",
"transactionID": "e491e9b4-8bc8-49b3-957a-2074df3161b7-a298d",
"product": {
"balance": 200.0,
"amount": 200.0,
"status": "D",
"metafields": {
"metafield": [
{
"name": "ddpId",
"value": "1680169056"
},
{
"name": "prodType",
"value": "pin_realtime"
},
{
"name": "serialNum",
"value": "8401331928"
}
]
}
}
}cancel
Petición
Ejemplo de parámetros de entrada
{
"transactionId":"e491e9b4-8bc8-49b3-957a-2074df3161b7-ad89c",
"amount":200.00,
"upc":"799366545682"
}Respuesta de petición existosa
{
"authID": "1318733930",
"responseCode": "0",
"responseText": "Success",
"transactionID": "e491e9b4-8bc8-49b3-957a-2074df3161b7-ad89c",
"product": {
"balance": 200.0,
"amount": 200.0,
"status": "D",
"metafields": {
"metafield": [
{
"name": "ddpId",
"value": "1680169057"
},
{
"name": "prodType",
"value": "pin_realtime"
},
{
"name": "serialNum",
"value": "8401331930"
}
]
}
}
}RetailInCommServiceAnchor
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 |
---|---|---|---|---|---|
makePurchase | com.oxxo.fintech.core.dto.gateway.request.RetailTransactionDigitalRequestGatewayDTO | Objeto que se espera del controlador y que será convertida al objeto de la petición para los servicios Incomm | com.oxxo.fintech.core.dto.gateway.response.IncommGatewayResponseDTO | 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 requestActiveCode expuesto en el microservicio incomm-gateway-service y el servicio requestActiveCode expuesto por parte de Incomm |
makeReverse | com.oxxo.fintech.core.dto.gateway.request.RetailTransactionDigitalRequestGatewayDTO | Petición que se espera del controlador y que será convertida al objeto de la petición para los servicios Incomm | com.oxxo.fintech.core.dto.gateway.response.IncommGatewayResponseDTO | 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 returnActiveCode expuesto en el microservicioincomm-gateway-service y el servicio returnActiveCode expuesto por parte de Incomm |
cancelPurchase | com.oxxo.fintech.core.dto.gateway.request.RetailTransactionDigitalRequestGatewayDTO | Petición que se espera del controlador y que será convertida al objeto de la petición para los servicios Incomm | com.oxxo.fintech.core.dto.gateway.response.IncommGatewayResponseDTO | 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 cancel expuesto en el microservicio incomm-gateway-service y el servicio cancel expuesto por parte de Incomm |
Cliente RetrofitAnchor
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.
IncommRetrofitClientAnchor
Controller
IncommRetrofitClient
Dependencias
com.oxxo.fintech.incomm.client.IncommRepository
Método | Parámetros de entrada | Detalle | Parámetros de salida | Detalle | Descripción |
---|---|---|---|---|---|
requestActiveCode | com.oxxo.fintech.incomm.client.dto.request.RequestIncommDTO | Objeto para realizar la petición al servicio requestActiveCode de Incomm | com.oxxo.fintech.incomm.client.dto.response.ResponseIncommDTO | Objeto de respuesta de consumo del servicio requestActiveCode de Incomm | Realiza la ejecución del llamado a la petición rest |
returnActiveCode | com.oxxo.fintech.incomm.client.dto.request.RequestIncommDTO | Objeto para realizar la petición al servicio returnActiveCode de Incomm | com.oxxo.fintech.incomm.client.dto.response.ResponseIncommDTO | Objeto de respuesta de consumo del servicio returnActiveCode de Incomm | Realiza la ejecución del llamado a la petición rest |
cancelActiveCode | com.oxxo.fintech.incomm.client.dto.request.RequestIncommDTO | Objeto para realizar la petición al servicio cancel de Incomm | com.oxxo.fintech.incomm.client.dto.response.ResponseIncommDTO | Objeto de respuesta de consumo del servicio cancel de Incomm | Realiza la ejecución del llamado a la petición rest |
validateResponse | retrofit2.Response ErrorCode | Objeto que contiene la respuesta del cliente Retrofit com.spin.common.core.errors 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. |
getDefaultErrorCode | --- | --- | com.spin.common.core.errors.ErrorCode | 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