production
development
https://api.banamex.com/mx-gcgapi
Paths
/v1/x-global/customers/session/info
get /v1/x-global/customers/session/info
Customer Sessions Info
Get the Session Data from legacy systems.
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)
uuid
Required in header
string
A 128 bit universally unique identifier (UUID) that you generate for every request and is used for tracking. It is recommended to use the output from Java UUID class or an equivalent. If not provided by APP, PSG will generate it.
{
"default": "a7d1e304-83a9-4413-af97-62615e57eae66807840"
}Accept
Required in header
string
Content-Types that are acceptable for the response. Currently we support application/json.If not provided by APP, PSG will generate it.
{
"default": "application\/json"
}Content-Type
Required in header
string
This is the HTTP Content-Type.If not provided by APP, PSG will generate it.
{
"default": "application\/json"
}Accept-Language
Required in header
string
HTTP Accept-Language header.If not provided by APP, PSG will add default.
{
"default": "en-US"
}countryCode
Required in header
string
2 character ISO country code.If not provided by APP, PSG will add default
{
"default": "MX"
}businessCode
Required in header
string
business code.If not provided by APP, PSG will add default
{
"default": "GCB"
}channelId
Required in header
string
Channel Id identifies the consumer from where the request comes
sid
Required in header
string
sid
{
"default": "abbb4837-8343-418c-93d8-77a8519dff9e"
}Authorization
Required in header
string
The Authorization Token received during login.The scope will be limited till APIGateway.
{
"default": "asdfkjsaldfjasfiewetowtllasgflasfspfwerfjwejrowglklasdfaslf"
}client_id
Required in header
string
The client ID you received during application registration in the developer portal.The scope will be limited till APIGateway.
{
"default": "29738e5a-fbbf-4b55-981d-d2f3d2a60605"
}200
Session Data Retrieved Successfully
400
(BAD REQUEST) - Request was not processed
| Type | Code | Details |
| invalid | invalidRequest | Missing Parameters |
| invalid | notAvailable | Session Data is Not Available for this Customer |
401
Unauthorized - Client must authenticate itself to get the requested response
| Type | Code | Details |
| error | unAuthorized | Authorization credentials are missing or invalid |
403
(FORBIDDEN) - Unauthorized to perform the requested operation on resource
| Type | Code | Details | More Info |
| invalid | accessNotConfigured | The request operation is not configured to access this resource | Channel/Country/Business provided in the request is not supported currently |
404
(Not Found) - The requested resource could not be found but may be available in the future.
| Type | Code | Details | More Info |
| error | resourceNotFound | The requested resource was not found | Empty resource/resource not found |
500
(INTERNAL SERVER ERROR) - API Server Error
| 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/customers/session/info
Try this operation
Definitions
{
"type": "object",
"properties": {
"stationNumber": {
"description": "stationNumber",
"type": "integer",
"example": 5739,
"maxLength": 4
},
"stationName": {
"description": "stationName",
"type": "string",
"example": "T086N20",
"maxLength": 8
},
"serviceTransactionId": {
"description": "transactionId",
"type": "integer",
"example": 100100,
"maxLength": 6
},
"messageIndex": {
"description": "index number of the message",
"type": "integer",
"example": 456001,
"maxLength": 6
},
"stationSessionCount": {
"description": "Customer Id",
"type": "integer",
"example": 1,
"maxLength": 2
},
"dataCenterLocation": {
"description": "Data Center location (CSI)",
"type": "string",
"example": 10
},
"agentSessionFlag": {
"description": "agentSessionFlag",
"type": "integer",
"example": 2,
"maxLength": 1
},
"customerSessionFlag": {
"description": "customerSessionFlag",
"type": "integer",
"example": 2,
"maxLength": 1
},
"branchId": {
"description": "branchId",
"type": "integer",
"example": 1000,
"maxLength": 4
},
"agentId": {
"description": "agentId",
"type": "integer",
"example": 1234,
"maxLength": 4
},
"allowedServiceTransactionCode": {
"description": "allowedTransactionCode",
"type": "integer",
"example": 3,
"maxLength": 2
},
"ipAddress": {
"description": "ipAddress",
"type": "string",
"example": "1.0.0.1",
"maxLength": 15
},
"ipType": {
"description": "ipType",
"type": "integer",
"example": 1,
"maxLength": 2
},
"lastAccessDate": {
"description": "lastAccessDate",
"type": "string",
"format": "date",
"example": "20180806",
"maxLength": 8
},
"lastAccessTime": {
"description": "lastAccessTime",
"type": "integer",
"example": 213515,
"maxLength": 6
},
"lastChannelId": {
"description": "last channel Id",
"type": "string",
"example": "123456ABC",
"maxLength": 20
},
"userCapabilities": {
"type": "array",
"items": {
"$ref": "#/definitions/UserCapabilities"
}
},
"respresentativeService": {
"type": "array",
"items": {
"$ref": "#/definitions/RepresentativeService"
}
}
},
"required": [
"stationNumber",
"stationName",
"serviceTransactionId",
"messageIndex",
"stationSessionCount",
"agentSessionFlag",
"customerSessionFlag",
"branchId",
"agentId",
"allowedServiceTransactionCode",
"ipAddress",
"ipType",
"lastAccessDate",
"lastAccessTime",
"lastChannelId"
]
}
{
"type": "object",
"properties": {
"currencyCode": {
"description": "currencyCode",
"type": "integer",
"example": 1,
"maxLength": 2
},
"dailyTransactionThreshold": {
"description": "individualDailyTransactionThreshold",
"type": "number",
"format": "double",
"example": 99999999999999.98,
"maxLength": 14
},
"jointDailyTransactionThreshold": {
"description": "jointDailyTransactionThreshold",
"type": "number",
"format": "double",
"example": 99999999999999.98,
"maxLength": 14
},
"frequencyTransactionThreshold": {
"description": "periodTransactionThreshold",
"type": "number",
"format": "double",
"example": 99999999999999.98,
"maxLength": 14
},
"frequencyCode": {
"description": "periodCode",
"type": "integer",
"example": 1,
"maxLength": 2
},
"transactionCategoryCode": {
"description": "transactionCategoryCode",
"type": "integer",
"example": 1,
"maxLength": 2
},
"transactionClassification": {
"description": "transactionClassification",
"type": "integer",
"example": 10000009,
"maxLength": 8
}
},
"required": [
"currencyCode",
"dailyTransactionThreshold",
"jointDailyTransactionThreshold",
"frequencyTransactionThreshold",
"frequencyCode",
"transactionCategoryCode",
"transactionClassification"
]
}
{
"type": "object",
"properties": {
"customerServiceNumber": {
"description": "customerServiceNumber",
"type": "integer",
"example": 5544,
"maxLength": 4
},
"customerCategoryType": {
"description": "customerCategoryType",
"type": "integer",
"example": 20,
"maxLength": 2
},
"serviceStatus": {
"description": "serviceStatus",
"type": "integer",
"example": 1,
"maxLength": 2
},
"representativeIndex": {
"description": "Representative Index",
"type": "integer",
"example": 1,
"maxLength": 2
}
},
"required": [
"customerServiceNumber",
"customerCategoryType",
"serviceStatus",
"representativeIndex"
]
}
{
"required": [
"type",
"code"
],
"properties": {
"type": {
"type": "string",
"enum": [
"error",
"warn",
"invalid",
"fatal"
],
"description": "
invalid - Request did not confirm to the specification and was unprocessed & rejected. Please fix the value and try again
warn - Request was partially processed. E.g. some of the fields are missing in response to the system issues, request was accepted successfully but will be processed asynchronously
error - The request was accepted but could not be processed successfully
fatal - There was an internal system error while processing the request. These are technical errors and will be resolved by Citi, and the consumer should retry after some time. Business errors will not be categorized as 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"
}
}
}