production
development
https://api.banamex.com/mx-gcgapi
Paths
/v1/x-global/sms/otp/send
post /v1/x-global/sms/otp/send
sms-otp-send
Sends OTP to SMS service
This API is to send OTP to SMS client through movilé
OAuth2 Application Flow
OAuth2 Application Flow
(oauth2 application)
Token URL
https://api.banamex.com/mx-gcgapi/api/v1/oauth/token
Scopes
/api/v1
ClientID
X-IBM-Client-Id
(apiKey located in header)
uuid
Required in header
string
Random 128 bit UUID generated uniquely for every request from the Customer, which will represent transaction unique identifier and it is recommended to send.
countryCode
Required in header
string
Two character ISO country code.
{
"default": "MX"
}businessCode
Required in header
string
Three character business code.
{
"default": "GCB"
}channelId
Optional in header
string
Channel ID used by the user.
client_id
Required in header
string
The client ID you received during application registration in the developer portal
Authorization
Required in header
string
Bearer token aquired from APIM token endpoint
Accept-Language
Optional in header
string
Language to be send to the backend systems
{
"default": "es"
}Content-Type
Required in header
string
Content-Types that are sent in the request
{
"default": "application\/json"
}Accept
Required in header
string
Content-Types that are acceptable for the response.
smsRequest
Required in body
object
This request is to provide data for sending SMS.
200
Send SMS Successful
400
Bad Request
| Type | Code | Details |
| error | invalidRequest | Missing or invalidParameters |
403
Forbidden
| Type | Code | Details |
| error | accessNotConfigured | The request operation is not configured to access this resource. |
500
Internal Server Error
| Type | Code | Details |
| fatal | serverUnavailable | The request failed due to an internal error/server unavailability |
| error | deliveryResult | Error message |
Example Request
Example Response
POST https://api.banamex.com/mx-gcgapi/api/v1/x-global/sms/otp/send
Try this operation
Definitions
{
"required": [
"oneTimePassword ",
"phoneNumber"
],
"properties": {
"oneTimePassword ": {
"type": "string",
"example": "1234567890",
"description": "OTP for customer to login"
},
"phoneNumber": {
"type": "string",
"example": "551234567890",
"description": "Registered valid number for customer"
}
}
}
{
"required": [
"code",
"details",
"location",
"moreInfo",
"timestamp",
"type"
],
"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": {
"type": "string",
"description": "Error code which qualifies the error"
},
"details": {
"type": "string",
"description": "Human readable explanation specific to the occurrence of the problem"
},
"location": {
"type": "string",
"description": "The name of the field that resulted in the error"
},
"moreInfo": {
"type": "string",
"description": "URI to human readable documentation of the error"
},
"timestamp": {
"type": "string",
"description": "Timestamp of the error"
}
}
}