production
development
https://api.banamex.com/mx-gcgapi
Paths
/v1/products/recommend/{age}/{monthlyIncomeAmount}/{passion}
get /v1/products/recommend/{age}/{monthlyIncomeAmount}/{passion}
CreditCardProfile
The API is used to suggest credit cards based upon the monthlyIncomeAmount, age and passion of the person.
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
OAuth2 Application Flow
OAuth2 Application Flow
(oauth2 application)
Token URL
https://api.banamex.com/mx-gcgapi/api/v1/oauth/token
Scopes
/api/v1
Client ID
X-IBM-Client-Id
(apiKey located in header)
client_id
Required in header
string
Client ID generated during application registration
Authorization
Required in header
string
The Authorization Token received during login
Accept
Required in header
string
Content-Types that are acceptable for the response
uuid
Required in header
string
128 bit UUID that you generate for every request
Accept-Language
Optional in header
string
List of acceptable human languages for response
sid
Required in header
string
SessionId sent by Consumer
passion
Required in path
string
Passion of the CitiBanamex client
age
Required in path
integer
Unique Identifier of the customer
monthlyIncomeAmount
Required in path
number / double
monthlyIncomeAmount of the person
200
Successful operation.
400
Type | Code | Details |
error | invalidRequest | Missing or invalid Parameters |
401
Type | Code | Details |
error | unAuthorized | Authorization credentials are missing or invalid |
403
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 |
404
Type | Code | Details | More Info |
error | resourceNotFound | The requested resource was not found | Empty resource/resource not found |
500
Type | Code | Details |
fatal | serverUnavailable | The request failed due to an internal error/server unavailability |
Example Request
Example Response
GET https://api.banamex.com/mx-gcgapi/api/v1/products/recommend/{age}/{monthlyIncomeAmount}/{passion}
Try this operation
No response. This is a mixed content call. It is not possible to test HTTP APIs from an HTTPS secured Portal site and vice versa.
No response. This is a cross-origin call. Make sure the server accepts requests from this portal. Or if using self-signed SSL certificates then paste the URL above into your browser to accept the certificate before trying again (On Internet Explorer it must be the same browser tab.).
Definitions
{
"properties": {
"ProductType": {
"description": "Types of Credit card",
"example": "AFINITY_CARD",
"type": "string"
}
},
"required": [
"ProductType"
]
}
{
"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"
]
}
{
"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"
}
}
}
{
"properties": {
"party": {
"$ref": "#/definitions/Party"
}
},
"type": "object"
}