production
development
https://api.banamex.com/mx-gcgapi
Paths
/v1/x-global/bne/representatives/credentials/change
post /v1/x-global/bne/representatives/credentials/change
change-credential
LOB:Security; Feature:BNE credentials; Functionality:Credential Change
This API is used to change the representative credential
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
{
"default": "es"
}Content-Type
Required in header
string
Content-Types that are sent in the request
{
"default": "application\/json"
}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
{
"default": "GCB"
}ChannelId
Required in header
string
Channel where request originated
sid
Required in header
string
SessionId sent by Consumer
changeCredentialRequest
Optional 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/bne/representatives/credentials/change
Try this operation
Definitions
{
"type": "object",
"properties": {
"encryptedNewCredentialText": {
"description": "New credential set by the user for authentication. This value must be encrypted using E2E-Encryption.",
"type": "string",
"example": "jlijsdifjosigjo32oie52goijwogwe342ngwij4o9ojowjoegj"
},
"encryptedOldCredentialText": {
"description": "Old credential text used by the user for authentication. This value must be encrypted using E2E-Encryption.",
"type": "string",
"example": "jlijsdifjosigjo32oie52goijwogwe342ngwij4o9ojowjoegj"
}
},
"required": [
"encryptedNewCredentialText",
"encryptedOldCredentialText"
]
}
{
"properties": {
"type": {
"type": "string",
"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"
]
},
"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"
},
"uuid": {
"description": "128 bit UUID that you generate for every request",
"type": "string"
},
"timestamp": {
"description": "timestamp of the error",
"type": "string"
}
},
"required": [
"type",
"code"
]
}