APIs Giftcards Favorite Providers

Documentación de API para la lista de Proveedores Favoritos dentro de Tarjetas de Regalo.

Métodos	Parámetros de entrada	Parámetro de salida	URL	Detalles

Métodos	Parámetros de entrada	Parámetro de salida	URL	Detalles
`GET`		`PagoPopApiDTO.GiftcardService.FavoriteProviderResponseChannelDTO`	`{host}/mobile/giftcard-service/users/favorite-providers`	Endpoint que retorna el listado de proveedores favoritos por usuario, hasta un máximo de 7 proveedores.
`POST`	`{providerId}`	`PagoPopApiDTO.GiftcardService.FavoriteProviderResponseChannelDTOList`	`{host}//mobile/giftcard-service/users/favorite-providers/{providerId}`	Endpoint que añade un proveedor al listado de proveedores favoritos del usuario, hasta un máximo de 7 proveedores.
`DELETE`	`{providerId}`	`PagoPopApiDTO.GiftcardService.FavoriteProviderResponseChannelDTOList`	`{host}/mobile/giftcard-service/users/favorite-providers/{providerId}`	Endpoint que remueve un proveedor del listado de proveedores favoritos del usuario.

Ejemplo peticiones

GET https://{host}/mobile/giftcard-service/users/favorite-providers

Respuesta de petición existosa

{
    "favoriteProviderList": [
        {
            "id": "63ee9b2296131715387b0bc8",
            "userId": "ebdd1eaf-3685-472f-9339-3a0d61151810",
            "providerId": "63874e770af87b3f929cabbc",
            "providerName": "Reforma",
            "providerLogo": "https://dev.storage.oxxofintech.com.mx/giftcards/providers/reforma.png",
            "createdAt": "2023-02-16T21:07:46.236Z"
        },
        {
            "id": "63d303ab80659b053161d279",
            "userId": "ebdd1eaf-3685-472f-9339-3a0d61151810",
            "providerId": "63874a900af87b3f929cabaf",
            "providerName": "Rixty",
            "providerLogo": "https://dev.storage.oxxofintech.com.mx/giftcards/providers/rixty.png",
            "createdAt": "2023-01-26T22:50:19.635Z"
        },
        {
            "id": "63d2e72451c7707bef74a774",
            "userId": "ebdd1eaf-3685-472f-9339-3a0d61151810",
            "providerId": "63874cc20af87b3f929cabb5",
            "providerName": "Xbox",
            "providerLogo": "https://dev.storage.oxxofintech.com.mx/giftcards/providers/xbox.png",
            "createdAt": "2023-01-26T20:48:36.097Z"
        },
        {
            "id": "63d2e6784bfbe053d45f5a34",
            "userId": "ebdd1eaf-3685-472f-9339-3a0d61151810",
            "providerId": "63874b550af87b3f929cabb2",
            "providerName": "Envía flores",
            "providerLogo": "https://dev.storage.oxxofintech.com.mx/giftcards/providers/envia_flores.png",
            "createdAt": "2023-01-26T20:45:44.22Z"
        },
        {
            "id": "63d2e11b10d68735e53894f4",
            "userId": "ebdd1eaf-3685-472f-9339-3a0d61151810",
            "providerId": "63874c670af87b3f929cabb4",
            "providerName": "Microsoft CIS",
            "providerLogo": "https://dev.storage.oxxofintech.com.mx/giftcards/providers/microsoft.png",
            "createdAt": "2023-01-26T20:22:51.193Z"
        },
        {
            "id": "63d2e0ae10d68735e53894f3",
            "userId": "ebdd1eaf-3685-472f-9339-3a0d61151810",
            "providerId": "63874a2c0af87b3f929cabae",
            "providerName": "Viacom",
            "providerLogo": "https://dev.storage.oxxofintech.com.mx/giftcards/providers/paramount.png",
            "createdAt": "2023-01-26T20:21:02.702Z"
        }
    ]
}

POST https://{host}/mobile/giftcard-service/users/favorite-providers/{providerId}

Ejemplo de parámetros de entrada

63874a2c0af87b3f929cabae

Respuesta de petición existosa

{
        "id": "63d2e0ae10d68735e53894f3",
        "userId": "ebdd1eaf-3685-472f-9339-3a0d61151810",
        "providerId": "63874a2c0af87b3f929cabae",
        "providerName": "Viacom",
        "providerLogo": "https://dev.storage.oxxofintech.com.mx/giftcards/providers/paramount.png",
        "createdAt": "2023-01-26T20:21:02.702Z"
}

DELETE https://{host}/mobile/giftcard-service/users/favorite-providers/{providerId}

Ejemplo de parámetros de entrada

Respuesta de petición existosa

NOTA: puesto que la respuesta de la solicitud DELETE es exitosa, la entrada con el ID provisto de ejemplo (63874a2c0af87b3f929cabae) es removido exitosamente y el servicio no regresa nada.