production
development
https://api.banamex.com/mx-gcgapi
Paths
/v1/x-global/security/soft-token/validate
post /v1/x-global/security/soft-token/validate
validate-soft-token
To validate a transaction authentication using Transmit soft token
This API is used to validate a transaction authentication using Transmit soft token
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
Optional in header
string
Client ID generated during application registration
Authorization
Optional 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
businessCode
Required in header
string
Business code identified during application registration
ChannelId
Required in header
string
Channel where request originated
sid
Optional in header
string
SessionId sent by Consumer
softTokenValidateRequest
Required in body
object
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
POST https://api.banamex.com/mx-gcgapi/api/v1/x-global/security/soft-token/validate
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
{
"type": "object",
"properties": {
"jwtToken": {
"type": "string",
"example": "kkhljsdf87sdifskjfsdhkf8fsdf",
"description": "JWT to validate customer email."
},
"grantType": {
"type": "string",
"example": "2",
"maxLength": 2,
"pattern": "^[0-9]{1,2}$",
"description": "Id of the token, used for identifying the kind of functional Id also known as applicationId for calling the transmit JWT validator service tokenId Details 1 SMS-OTP functional Id 2 binding functional Id 3 New Online Transaction functional Id 4 Avatar Transaction functional Id 5 IVR Transaction functional ID 6 AcciTrade Transaction functional ID 7 Directo Transaction functional ID
"
},
"customer": {
"$ref": "#/definitions/Customer"
}
},
"required": [
"jwtToken",
"customer"
]
}
{
"type": "object",
"properties": {
"customerId": {
"description": "Unique identifier of the customer",
"type": "string",
"example": "123456789012",
"maxLength": 12
},
"legalRepresentativeId": {
"description": "Unique identifier for corporate legal Representative. Only for Corporate customers",
"type": "string",
"pattern": "^[0-9]{1,2}$",
"example": "1",
"maxLength": 2
}
},
"required": [
"customerId"
]
}
{
"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": "More Info can be used to pass any additional details",
"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"
]
}