production
development
https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext
Paths
/v1/customers/codi-banxico/enrollment
post /v1/customers/codi-banxico/enrollment
codi-banxico-enrollment
The API is is used for enrollment of CODi app with Banxico using Banamex App
The API is is used for enrollment of CODi app with Banxico using Banamex App
OAuth2 Application Flow
OAuth2 Application Flow
(oauth2 application)
Token URL
https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext/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
codiBanxicoEnrollmentRequest
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://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext/api/v1/customers/codi-banxico/enrollment
Definitions
{
"type": "object",
"properties": {
"sourceKey": {
"description": "Keysource generated with a SHA-512 encryption method. String value to decrypt the google id which is in turn sent to firebase",
"type": "string",
"example": "axvcsds23454AsdscxFge"
},
"firebaseGoogleId": {
"description": "Encrypted GoogleId returned after initial register with Banxico",
"type": "string",
"example": ""
},
"banxicoCheckCode": {
"description": "Dv field sent by Banxico after regsiter and validation.",
"type": "integer",
"format": "int32",
"example": 0
},
"firebaseId": {
"description": "Id returned after sending decrypted Google Id to Firebase",
"type": "string",
"example": ""
},
"deviceDetails": {
"$ref": "#/definitions/Device"
}
},
"required": [
"sourceKey",
"firebaseGoogleId",
"banxicoCheckCode",
"firebaseId",
"deviceDetails"
]
}
{
"type": "object",
"properties": {
"phoneNumber": {
"description": "CoDi client phone number",
"type": "integer",
"format": "int32",
"example": 5512345678
},
"deviceSerialNumber": {
"description": "Id of the cell phone used to enroll in CoDi. Generated automatically by the app using the phone information",
"type": "string",
"example": "fa7asd69xsd"
},
"deviceOsName": {
"description": "Operative system of the device",
"type": "string",
"example": "Android"
},
"deviceOsVersion": {
"description": "Operative system version of the device",
"type": "string",
"example": "Oreo 8.1"
},
"deviceMake": {
"description": "Manufacturer of the device",
"type": "string",
"example": "Motorola"
},
"deviceModel": {
"description": "Model of the device",
"type": "string",
"example": "Moto g5"
}
},
"required": [
"phoneNumber",
"deviceSerialNumber",
"deviceOsName",
"deviceOsVersion",
"deviceMake",
"deviceModel"
]
}
{
"type": "object",
"properties": {
"banamexDefaultCodiBankingAppFlag": {
"description": "Flag that determines if Citibanamex app is the default app for CoDi",
"type": "boolean",
"example": true
},
"databaseRegistrationId": {
"description": "Id of the client in Citi DB, it must be stored in client device because it will needed for every subsequent register request",
"type": "string",
"example": "12345"
}
},
"required": [
"banamexDefaultCodiBankingAppFlag",
"databaseRegistrationId"
]
}
{
"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"
]
}