---
basePath: /api
definitions:
CardRecommendation:
properties:
ProductType:
description: Types of Credit card
example: AFINITY_CARD
type: string
required:
- ProductType
ErrorResponse:
properties:
code:
description: Error code which qualifies the error
type: string
details:
description: Human readable explanation specific to the occurrence of the
problem
type: string
location:
description: The name of the field that resulted in the error
type: string
moreInfo:
description: URI to human readable documentation of the error
type: string
type:
description: Invalid - Request did not confirm to the specification and was
unprocessed and rejected. Please fix the value and try again
enum:
- error
- warn
- invalid
- fatal
type: string
required:
- type
- code
Party:
properties:
age:
description: Age of the person
example: "23"
type: integer
cardRecommendation:
items:
$ref: '#/definitions/CardRecommendation'
type: array
monthlyIncomeAmount:
description: monthlyIncomeAmount of the person
example: "21345.12"
format: decimal
type: number
passion:
description: Passion of the person
example: Sports
type: string
RetrieveCardRecommendationResponse:
properties:
party:
$ref: '#/definitions/Party'
type: object
host: 127.0.0.1
info:
description: ' API for Credit Card Profile'
title: PRDT-PDR-D-ProductRecomendation
version: 1.0.0
x-ibm-name: prdt-pdr-d-productrecomendation
name: ""
paths:
/v1/products/recommend/{age}/{monthlyIncomeAmount}/{passion}:
get:
consumes:
- application/json
description: To suggest credit cards based upon themonthlyIncomeAmount, age
and passion of the person. The scope of this API is private, post-login and
entry-point
parameters:
- description: Client ID generated during application registration
in: header
name: client_id
required: true
type: string
- description: The Authorization Token received during login
in: header
name: Authorization
required: true
type: string
- description: Content-Types that are acceptable for the response
in: header
name: Accept
required: true
type: string
- description: 128 bit UUID that you generate for every request
in: header
name: uuid
required: true
type: string
- description: List of acceptable human languages for response
in: header
name: Accept-Language
required: false
type: string
- description: SessionId sent by Consumer
in: header
name: sid
required: true
type: string
- description: Passion of the CitiBanamex client
in: path
name: passion
required: true
type: string
- description: Unique Identifier of the customer
in: path
name: age
required: true
type: integer
- description: monthlyIncomeAmount of the person
format: double
in: path
name: monthlyIncomeAmount
required: true
type: number
produces:
- application/json
responses:
200:
description: Successful operation.
schema:
$ref: '#/definitions/RetrieveCardRecommendationResponse'
400:
description:
Type | Code | Details |
error | invalidRequest | Missing
or invalid Parameters |
schema:
$ref: '#/definitions/ErrorResponse'
401:
description: Type | Code | Details |
error | unAuthorized | Authorization
credentials are missing or invalid |
schema:
$ref: '#/definitions/ErrorResponse'
403:
description: Type | Code | Details | More
Info |
error | accessNotConfigured | The request
operation is not configured to access this resource | Channel/Country/Business
provided in the request is not supported currently |
schema:
$ref: '#/definitions/ErrorResponse'
404:
description: Type | Code | Details | More
Info |
error | resourceNotFound | The requested
resource was not found | Empty resource/resource not found |
schema:
$ref: '#/definitions/ErrorResponse'
500:
description: Type | Code | Details |
fatal | serverUnavailable | The
request failed due to an internal error/server unavailability |
schema:
$ref: '#/definitions/ErrorResponse'
summary: The API is used to suggest credit cards based upon the monthlyIncomeAmount,
age and passion of the person.
tags:
- CreditCardProfile
produces:
- application/json
schemes:
- https
swagger: "2.0"
x-ibm-configuration:
enforced: true
testable: true
phase: realized
securityDefinitions:
OAuth2 Application Flow:
type: oauth2
description: ""
flow: application
scopes:
/api/v1: ""
tokenUrl: https://api.banamex.com/mx-gcgapi/api/v1/oauth/token
Client ID:
type: apiKey
description: ""
in: header
name: X-IBM-Client-Id
security:
- OAuth2 Application Flow:
- /api/v1
Client ID: []
x-ibm-endpoints:
- endpointUrl: https://api.banamex.com/mx-gcgapi
type:
- production
- development
...