production
development
https://api.banamex.com/mx-gcgapi
Paths
/v1/x-global/account-opening/rao/security/tokens/generate
post /v1/x-global/account-opening/rao/security/tokens/generate
generate-rao-otp
LOB: AO; Feature: OTP Token; Functionality: Generate;
This API will be used to generate the OTP token with the associated customer cell phone number.
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
Content-Type
Required in header
string
Content-Types that are sent in the request
countryCode
Required in header
string
Country code in 2 character ISO 3166 format
{
"default": "MX"
}businessCode
Required in header
string
Business code identified during application registration
ChannelId
Required in header
string
Channel where request originated
sid
Required in header
string
SessionId sent by Consumer
generateRaoOtpRequest
Required in body
object
204
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 |
422
| Type | Code | Details |
| error | businessValidationFailed | Business validation error occured on one or more parameters |
500
| Type | Code | Details |
| fatal | serverUnavailable | The request failed due to an internal error/server unavailability |
Example Request
Example Response
POST https://api.banamex.com/mx-gcgapi/api/v1/x-global/account-opening/rao/security/tokens/generate
Try this operation
/v1/x-global/account-opening/rao/security/tokens/validate
post /v1/x-global/account-opening/rao/security/tokens/validate
validate-rao-otp
LOB: AO; Feature: OTP Token; Functionality: Validate;
This API will be used to validate the OTP token with the associated customer cell phone number.
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
Content-Type
Required in header
string
Content-Types that are sent in the request
countryCode
Required in header
string
Country code in 2 character ISO 3166 format
{
"default": "MX"
}businessCode
Required in header
string
Business code identified during application registration
ChannelId
Required in header
string
Channel where request originated
sid
Required in header
string
SessionId sent by Consumer
validateRaoOtpRequest
Required in body
object
204
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 |
422
| Type | Code | Details |
| error | businessValidationFailed | Business validation error occured on one or more parameters |
500
| Type | Code | Details |
| fatal | serverUnavailable | The request failed due to an internal error/server unavailability |
Example Request
Example Response
POST https://api.banamex.com/mx-gcgapi/api/v1/x-global/account-opening/rao/security/tokens/validate
Try this operation
/v1/x-global/account-opening/rao/security/tokens/certified-phone
get /v1/x-global/account-opening/rao/security/tokens/certified-phone
retrieve-rao-certified-phone-otp
LOB: AO; Feature: OTP Token; Functionality: Certified phone;
This API will retrieve certified phone number by transmit OTP
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
Content-Type
Optional in header
string
Content-Types that are sent in the request
countryCode
Required in header
string
Country code in 2 character ISO 3166 format
{
"default": "MX"
}businessCode
Required in header
string
Business code identified during application registration
ChannelId
Required in header
string
Channel where request originated
sid
Required in header
string
SessionId sent by Consumer
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 |
422
| Type | Code | Details |
| error | businessValidationFailed | Business validation error occured on one or more parameters |
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/x-global/account-opening/rao/security/tokens/certified-phone
Try this operation
Definitions
{
"type": "object",
"properties": {
"phoneCountryCode": {
"type": "string",
"description": "Country codes area of the international telephone numbering",
"maxLength": 5,
"pattern": "^\\+\\d{1,4}$",
"example": "+52"
},
"encryptedPhoneNumber": {
"type": "string",
"description": "The encrypted phone number of the user for which OTP needs to be delivered",
"format": "byte",
"example": "U3dhZ2dlciByb2Nrcw=="
}
},
"required": [
"phoneCountryCode",
"encryptedPhoneNumber"
]
}
{
"type": "object",
"properties": {
"phoneCountryCode": {
"type": "string",
"description": "Country codes area of the international telephone numbering",
"maxLength": 5,
"pattern": "^\\+\\d{1,4}$",
"example": "+52"
},
"encryptedPhoneNumber": {
"type": "string",
"description": "The encrypted phone number of the user for which OTP needs to be delivered",
"format": "byte",
"example": "U3dhZ2dlciByb2Nrcw=="
}
},
"required": [
"phoneCountryCode",
"encryptedPhoneNumber"
]
}
{
"type": "object",
"properties": {
"encryptedOtpToken": {
"type": "string",
"description": "Clear OTP Token",
"format": "byte",
"example": "U3dhZ2dlciByb2Nrcw=="
},
"phone": {
"$ref": "#/definitions/Phone"
}
},
"required": [
"phone",
"encryptedOtpToken"
]
}
{
"type": "object",
"properties": {
"phoneCountryCode": {
"type": "string",
"description": "Country codes area of the international telephone numbering",
"example": "+52"
},
"phoneNumber": {
"type": "string",
"description": "The certified phone number for RAO",
"example": "553366998"
}
},
"required": [
"phoneCountryCode",
"phoneNumber"
]
}
{
"properties": {
"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"
},
"timestamp": {
"description": "Timestamp of the error response",
"type": "string"
},
"uuid": {
"description": "Uuid used in the request",
"type": "string"
},
"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"
}
}
}