Paths
/v1/customers/codi-banxico/devices/register/detail
To register the device and application detail in Banxico for Codi feature
The API will register the device and application detail in Banxico for Codi feature
Client ID generated during application registration
The Authorization Token received during login
Content-Types that are acceptable for the response
128 bit UUID that you generate for every request
List of acceptable human languages for response
Content-Types that are sent in the request
Channel where request originated
Country code in 2 character ISO 3166 format
Business code identified during application registration
SessionId sent by Consumer
Successful operation.
Type | Code | Details |
error | invalidRequest | Missing or invalid Parameters |
Type | Code | Details |
error | unAuthorized | Authorization credentials are missing or invalid |
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 |
Type | Code | Details | More Info |
error | resourceNotFound | The requested resource was not found | Empty resource/resource not found |
Type | Code | Details |
error | businessValidationFailed | Business validation error occured on one or more parameters |
Type | Code | Details |
fatal | serverUnavailable | The request failed due to an internal error/server unavailability |
/v1/customers/codi-banxico/devices/validate/detail
The API helps to validate the device and application detail with Banxico for Codi feature
The API helps to validate the device and application detail with Banxico for Codi feature
Client ID generated during application registration
The Authorization Token received during login
Content-Types that are acceptable for the response
128 bit UUID that you generate for every request
List of acceptable human languages for response
Content-Types that are sent in the request
Channel where request originated
Country code in 2 character ISO 3166 format
Business code identified during application registration
SessionId sent by Consumer
Successful operation.
Type | Code | Details |
error | invalidRequest | Missing or invalid Parameters |
Type | Code | Details |
error | unAuthorized | Authorization credentials are missing or invalid |
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 |
Type | Code | Details | More Info |
error | resourceNotFound | The requested resource was not found | Empty resource/resource not found |
Type | Code | Details |
error | businessValidationFailed | Business validation error occured on one or more parameters |
Type | Code | Details |
fatal | serverUnavailable | The request failed due to an internal error/server unavailability |
/v1/customers/codi-banxico/applications/set-default/detail
The API helps to set the default banking application for Codi
The API helps to set the default banking application for Codi
Client ID generated during application registration
The Authorization Token received during login
Content-Types that are acceptable for the response
128 bit UUID that you generate for every request
List of acceptable human languages for response
Content-Types that are sent in the request
Channel where request originated
Country code in 2 character ISO 3166 format
Business code identified during application registration
SessionId sent by Consumer
Successful operation.
Type | Code | Details |
error | invalidRequest | Missing or invalid Parameters |
Type | Code | Details |
error | unAuthorized | Authorization credentials are missing or invalid |
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 |
Type | Code | Details | More Info |
error | resourceNotFound | The requested resource was not found | Empty resource/resource not found |
Type | Code | Details |
error | businessValidationFailed | Business validation error occured on one or more parameters |
Type | Code | Details |
fatal | serverUnavailable | The request failed due to an internal error/server unavailability |
/v1/customers/codi-banxico/devices/detail/delete
To delete the device registry in Banxico for Codi feature
This API is used to delete the device registry in Banxico for Codi feature
Client ID generated during application registration
The Authorization Token received during login
Content-Types that are acceptable for the response
128 bit UUID that you generate for every request
List of acceptable human languages for response
Content-Types that are sent in the request
Channel where request originated
Country code in 2 character ISO 3166 format
Business code identified during application registration
SessionId sent by Consumer
Successful operation.
Type | Code | Details |
error | invalidRequest | Missing or invalid Parameters |
Type | Code | Details |
error | unAuthorized | Authorization credentials are missing or invalid |
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 |
Type | Code | Details | More Info |
error | resourceNotFound | The requested resource was not found | Empty resource/resource not found |
Type | Code | Details |
error | businessValidationFailed | Business validation error occured on one or more parameters |
Type | Code | Details |
fatal | serverUnavailable | The request failed due to an internal error/server unavailability |
Definitions
{
"type": "object",
"properties": {
"deviceDetails": {
"$ref": "#/definitions/Device"
}
}
}
{
"type": "object",
"properties": {
"deviceMake": {
"description": "Maker of the device which the client is using to enroll with Citibanamex CoDi",
"type": "string",
"example": "samsung"
},
"deviceModel": {
"description": "Model of the device which the client is using to enroll with Citibanamex CoDi",
"type": "string",
"example": "SM-G935F"
},
"deviceOsId": {
"description": "ID of the Operative system of the device with the client is using to enroll with Citibanamex CoDi",
"type": "string",
"example": "01"
},
"deviceOsName": {
"description": "Operative system of the device with the client is using to enroll with Citibanamex CoDi",
"type": "string",
"example": "Android"
},
"deviceOsVersion": {
"description": "Version of the operative system of the device which the user is using to enroll with Citibanamex CoDi",
"type": "string",
"example": "8.0.0"
},
"deviceSerialNumber": {
"description": "Serial number of the device which a new user is enrolling with Citibanamex CoDi",
"type": "string",
"example": "12d58955dcd9e1f4-com.citibanamex.banamexmobile"
}
},
"required": [
"deviceMake",
"deviceModel",
"deviceOsName",
"deviceOsVersion",
"deviceSerialNumber"
]
}
{
"type": "object",
"properties": {
"encryptedCodiDeviceId": {
"description": "Encrypted alias asigned by Banxico to identify the device uniquely",
"type": "string",
"example": "asfsSRTaxderty$%5fwe=="
},
"codiBankingAppId": {
"description": "Check code assigned by Banxico to identify the App in the device",
"type": "integer",
"example": 1
},
"encryptedGoogleId": {
"description": "Encrypted Id of the project enrolled with Google in order to request a new FirebaseId releated to the project",
"type": "string",
"example": "4OIemuIf04sMzbFBl_duDoWZOO4rADGviq0Rf4UCz-cYS6zvijYesfRbUR1a4BQqKUQ4z56cgmTyEjtQdQQgIz"
}
},
"required": [
"encryptedCodiDeviceId",
"codiBankingAppId",
"encryptedGoogleId"
]
}
{
"type": "object",
"properties": {
"firebaseId": {
"description": "Firebase id of the customer registered with Banxico in order to receive PUSH notifications",
"type": "string",
"example": "dUww7Jl4b9o:APA91bGHVzEMF6xdD_ZV1L4CF5ZgrBqDQGl9QO4OIemuIf04sMzbFBl_duDoWZOO4rADGviq0Rf4UCz-cYS6zvijYesfRbUR1a4BQqKUQ4z56cgmTyEjtQdQQgIz_-8KLRxmJdI9571o"
},
"codiDeviceId": {
"description": "Alias asigned by Banxico to identify the device uniquely",
"type": "string",
"example": "460912423578"
},
"codiBankingAppId": {
"description": "Check code assigned by Banxico to identify the App in the device",
"type": "integer",
"example": 1
},
"messageAuthenticationCode": {
"description": "Hashed message authentication code (HMAC) needed by Banxico to validate the request's authenticity",
"type": "string",
"example": "dUww7Jl4b9o:APA91bCF5ZgrBqDQGl9QO4OIemuIf-cYS6zvijYesf"
},
"deviceInfo": {
"$ref": "#/definitions/DeviceInfo"
}
},
"required": [
"firebaseId",
"codiDeviceId",
"codiBankingAppId",
"deviceInfo",
"messageAuthenticationCode"
]
}
{
"type": "object",
"properties": {
"deviceMake": {
"description": "Maker of the device which the client is using to enroll with Citibanamex CoDi",
"type": "string",
"example": "samsung"
},
"deviceModel": {
"description": "Model of the device which the client is using to enroll with Citibanamex CoDi",
"type": "string",
"example": "SM-G935F"
},
"deviceOsId": {
"description": "ID of the Operative system of the device with the client is using to enroll with Citibanamex CoDi",
"type": "string",
"example": "01"
},
"deviceOsName": {
"description": "Operative system of the device with the client is using to enroll with Citibanamex CoDi",
"type": "string",
"example": "Android"
},
"deviceOsVersion": {
"description": "Version of the operative system of the device which the user is using to enroll with Citibanamex CoDi",
"type": "string",
"example": "8.0.0"
},
"deviceSerialNumber": {
"description": "Serial number of the device which a new user is enrolling with Citibanamex CoDi",
"type": "string",
"example": "12d58955dcd9e1f4-com.citibanamex.banamexmobile"
}
},
"required": [
"deviceMake",
"deviceModel",
"deviceOsName",
"deviceOsVersion",
"deviceSerialNumber"
]
}
{
"type": "object",
"properties": {
"codiBankingAppId": {
"description": "Check code assigned by Banxico to identify the App in the device",
"type": "integer",
"example": 1
},
"codiBankingDefaultAppId": {
"description": "Check code that Banxico has for the default application in the device to get notifications",
"type": "integer",
"example": 2
}
},
"required": [
"codiBankingAppId",
"codiBankingDefaultAppId"
]
}
{
"type": "object",
"properties": {
"codiDeviceId": {
"description": "Alias asigned by Banxico to identify the device uniquely",
"type": "string",
"example": "460912423578"
},
"codiBankingAppId": {
"description": "Check code assigned by Banxico to identify the App in the device",
"type": "integer",
"example": 1
},
"messageAuthenticationCode": {
"description": "Hashed message authentication code (HMAC) needed by Banxico to validate the request's authenticity",
"type": "string",
"example": "dUww7Jl4b9o:APA91bCF5ZgrBqDQGl9QO4OIemuIf-cYS6zvijYesf"
}
},
"required": [
"codiDeviceId",
"codiBankingAppId",
"messageAuthenticationCode"
]
}
{
"type": "object",
"properties": {
"devices": {
"type": "array",
"items": {
"$ref": "#/definitions/DeviceData"
}
}
},
"required": [
"devices"
]
}
{
"type": "object",
"properties": {
"codiBankingAppId": {
"description": "Check code assigned by Banxico to identify the App in the device",
"type": "integer",
"example": 1
},
"firebaseId": {
"description": "Firebase id of the customer registered with Banxico in order to receive PUSH notifications",
"type": "string",
"example": "dUww7Jl4b9o:APA91bGHVzEMF6xdD_ZV1L4CF5ZgrBqDQGl9QO4OIemuIf04sMzbFBl_duDoWZOO4rADGviq0Rf4UCz-cYS6zvijYesfRbUR1a4BQqKUQ4z56cgmTyEjtQdQQgIz_-8KLRxmJdI9571o"
}
},
"required": [
"codiBankingAppId"
]
}
{
"type": "object",
"properties": {
"responses": {
"type": "array",
"items": {
"$ref": "#/definitions/Response"
}
}
},
"required": [
"responses"
]
}
{
"type": "object",
"properties": {
"responseCode": {
"description": "Response code for each phone sent in the array, according to its position",
"type": "string",
"example": "0"
},
"responseDescription": {
"description": "Response description for each phone sent in the array, accordign to its position",
"type": "string",
"example": "Device Deleted successfully"
}
},
"required": [
"responseCode",
"responseDescription"
]
}
{
"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"
]
}