production
development
https://api.banamex.com/mx-gcgapi
Paths
/v1/consumer-services/customers/retrieve
post /v1/consumer-services/customers/retrieve
search-customer-list
To get a list of 20 homonymous customers is retrieved by Name and one or more of these parameters address/date of birth/RFC/telephone
This API is used to get a list of 20 homonymous customers is retrieved by Name and one or more of these parameters address/date of birth/RFC/telephone
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
dataCenterLocation
Optional in header
string
CSI Data center location number
{
"maxLength": 2
}stationName
Optional in header
string
Computer name calling or executing API
{
"maxLength": 8
}source
Required in header
number
SourceSystem or Source Application calling the API
{
"maxLength": 6
}operator
Required in header
string
Executive ID accesing API
{
"maxLength": 10
}searchCustomerListRequest
Optional 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 |
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/consumer-services/customers/retrieve
Try this operation
/private/v1/consumer-services/agents/retrieve
post /private/v1/consumer-services/agents/retrieve
customer-by-agent
API to retrieve customers assigned to agent
Customer information retrieved from system 16
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
dataCenterLocation
Optional in header
string
CSI Data center location number
{
"maxLength": 2
}stationName
Optional in header
string
Computer name calling or executing API
{
"maxLength": 8
}source
Required in header
number
SourceSystem or Source Application calling the API
{
"maxLength": 6
}operator
Required in header
string
Executive ID accesing API
{
"maxLength": 10
}customerByAgentRequest
Optional 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 |
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/private/v1/consumer-services/agents/retrieve
Try this operation
/v1/consumer-services/customers/search/retrieve
post /v1/consumer-services/customers/search/retrieve
search-customer
To retrieve the homonymy contact details of the customer
This API is used to retrieve the homonymy contact details of the customer
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
ChannelId
Required in header
string
Channel where request originated
sid
Required in header
string
SessionId sent by Consumer
searchCustomerRequest
Optional 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/consumer-services/customers/search/retrieve
Try this operation
Definitions
{
"type": "object",
"properties": {
"addressLine1": {
"description": "Address Line 1",
"type": "string",
"example": "Reforma 490"
},
"birthDate": {
"description": "Date of birth of the Person",
"type": "string",
"format": "date",
"example": "2018-01-02"
},
"customerName": {
"description": "Customer Name",
"type": "string",
"example": "Josue"
},
"customerType": {
"description": "Type of the customer",
"type": "string",
"example": "Priority"
},
"phoneNumber": {
"description": "unstrutured/complete Telephone number",
"type": "string",
"example": "1234567890"
},
"phoneType": {
"description": "Type of phone",
"type": "string",
"example": "Home"
},
"postalCode": {
"description": "Postal code of address",
"type": "string",
"example": "01219"
},
"taxId": {
"description": "RFC Number",
"type": "string",
"example": "RIVX890228RN0"
}
},
"required": [
"customerName"
]
}
{
"type": "object",
"properties": {
"customerDetail": {
"type": "array",
"items": {
"$ref": "#/definitions/CustomerDetail"
}
}
}
}
{
"type": "object",
"properties": {
"addressLine1": {
"description": "Address Line 1",
"type": "string",
"example": "Reforma 490"
},
"customerId": {
"description": "Unique Identifier of the customer",
"type": "string",
"example": "123456789012"
},
"customerName": {
"description": "Customer Name",
"type": "string",
"example": "Josue"
},
"customerStatus": {
"description": "Status of the customer",
"type": "string",
"example": "1"
},
"dataCenterLocation": {
"description": "Customer CSI Number",
"type": "string",
"example": "1234"
},
"phoneNumber": {
"description": "unstrutured/complete Telephone number",
"type": "string",
"example": "1234567890"
},
"countryCode": {
"description": "Country Code",
"type": "string",
"example": "01"
},
"postalCode": {
"description": "Postal code of address",
"type": "string",
"example": "01219"
},
"taxId": {
"description": "RFC Number",
"type": "string",
"example": "RIVX890228RN0"
},
"curp": {
"description": "Type of goverment Id number, CURP",
"type": "string",
"example": "BEML920313HMCLNS09"
},
"curpValidated": {
"description": "Field to know if CURP has been validated",
"type": "string",
"example": "V"
}
},
"required": [
"customerName"
]
}
{
"type": "object",
"properties": {
"agentId": {
"description": "agentId",
"type": "string",
"example": "",
"maxLength": 8
},
"agentType": {
"description": "agentType",
"type": "string",
"example": "",
"maxLength": 2
},
"customerId": {
"description": "customerId",
"type": "string",
"example": "",
"maxLength": 12
}
},
"required": [
"agentId",
"agentType"
]
}
{
"type": "object",
"properties": {
"agent": {
"$ref": "#/definitions/Agent"
}
}
}
{
"type": "object",
"properties": {
"agentId": {
"description": "agentId",
"type": "string",
"example": "",
"maxLength": 8
},
"agentName": {
"description": "agentName",
"type": "string",
"example": "",
"maxLength": 36
},
"agentType": {
"description": "agentType",
"type": "string",
"example": "",
"maxLength": 2
},
"customer": {
"type": "array",
"items": {
"$ref": "#/definitions/Customer"
}
}
}
}
{
"type": "object",
"properties": {
"customerId": {
"description": "customerId",
"type": "string",
"example": "",
"maxLength": 12
},
"fullName": {
"description": "fullName",
"type": "string",
"example": "",
"maxLength": 55
},
"agentAssignedDate": {
"description": "agentAssignedDate",
"type": "string",
"format": "date",
"example": "2018-04-05",
"maxLength": 10
}
}
}
{
"properties": {
"fullName": {
"description": "The legal name that an individual is given at birth and/or recognized by a government or other legal entity, or which appears on a birth certificate.",
"type": "string",
"example": "Andrea Lopez Hluz"
},
"taxId": {
"description": "Tax ID Number of Person or corporation",
"type": "string",
"example": "GUGF920725"
},
"addressLine1": {
"description": "Address Line 1",
"type": "string",
"example": "Reforma 490"
},
"phoneNumber": {
"description": "Phone number of the customer",
"type": "string",
"example": "5518902653"
},
"postalCode": {
"description": "Postal code of the address",
"type": "string",
"example": "01219"
},
"stationName": {
"description": "Station Name",
"type": "string",
"example": "1234"
},
"birthDate": {
"description": "Date of birth of the Person",
"type": "string",
"format": "date",
"example": "2018-01-02"
}
},
"required": [
"fullName"
]
}
{
"type": "object",
"properties": {
"contactList": {
"type": "array",
"items": {
"$ref": "#/definitions/Contact"
}
}
}
}
{
"type": "object",
"properties": {
"dataCenterLocation": {
"description": "It is an identifier of the place where the User was created.",
"type": "string",
"example": "10"
},
"customerId": {
"description": "Customer Id",
"type": "string",
"example": "000004945914"
},
"curp": {
"description": "CURP id of the customer",
"type": "string",
"example": "CHLU141292HFARRL04"
},
"curpValidatedCode": {
"description": "Field to know if CURP has been validated",
"type": "string",
"example": "V"
}
}
}
{
"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 or detailed description 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"
]
}