RegisterCodiDeviceRequest

{
    "type": "object",
    "properties": {
        "encryptedDeviceDetails": {
            "$ref": "#/definitions/EncryptedDeviceDetails"
        },
        "phoneNumber": {
            "description": "CoDi client phone number",
            "type": "string",
            "example": "5512345678"
        }
    },
    "required": [
        "encryptedDeviceDetails",
        "phoneNumber"
    ]
}
              

EncryptedDeviceDetails

{
    "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": "1"
        },
        "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",
        "deviceOsId",
        "deviceOsName",
        "deviceOsVersion",
        "deviceSerialNumber"
    ]
}
              

RegisterCodiDeviceResponse

{
    "type": "object",
    "properties": {
        "encryptedCodiDeviceId": {
            "description": "Encrypted alias asigned by Banxico to identify the device uniquely",
            "type": "string",
            "example": "asfsSRTaxdfw#$%&e=="
        },
        "codiBankingAppId": {
            "description": "Check code assigned by Banxico to identify the App in the device",
            "type": "integer",
            "format": "int32",
            "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"
    ]
}
              

ValidateCodiDeviceDetailRequest

{
    "type": "object",
    "properties": {
        "encryptedValidateDevice": {
            "description": "Encrypted payload object as defined in the definitions swagger",
            "type": "string",
            "example": "Q34EDR56TF"
        }
    },
    "required": [
        "encryptedValidateDevice"
    ]
}
              

ValidateCodiDeviceDetailResponse

{
    "type": "object",
    "properties": {
        "codiBankingAppId": {
            "description": "Check code assigned by Banxico to identify the App in the device",
            "type": "integer",
            "format": "int32",
            "example": 1
        },
        "codiBankingDefaultAppId": {
            "description": "Check code that Banxico has for the default application in the device to get notifications",
            "type": "integer",
            "format": "int32",
            "example": 2
        }
    },
    "required": [
        "codiBankingAppId",
        "codiBankingDefaultAppId"
    ]
}
              

SetDefaultApplicationRequest

{
    "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",
            "format": "int32",
            "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"
    ]
}
              

SetDefaultApplicationInfoRequest

{
    "type": "object",
    "properties": {
        "customerId": {
            "description": "Unique identifier for the customer",
            "type": "string",
            "example": "109876542371"
        },
        "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",
            "format": "int32",
            "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"
    ]
}
              

DeleteDeviceRequest

{
    "type": "object",
    "properties": {
        "phoneNumber": {
            "description": "CoDi client phone number",
            "type": "string",
            "example": "5512345678"
        },
        "customerId": {
            "description": "Unique identifier for the customer",
            "type": "string",
            "example": "109876542371"
        },
        "legalRepresentativeId": {
            "description": "Unique identifier for corporate legal Representative. Only for Corporate customers",
            "type": "string",
            "example": "1",
            "maxLength": 2
        },
        "encryptedDeleteDevice": {
            "description": "Information on the device and account that will be removed from the Banxico service.",
            "type": "string",
            "example": "Q34EDR56TF"
        }
    },
    "required": [
        "phoneNumber",
        "customerId",
        "encryptedDeleteDevice"
    ]
}
              

DeleteDeviceInfoRequest

{
    "type": "object",
    "properties": {
        "phoneNumber": {
            "description": "CoDi client phone number",
            "type": "string",
            "example": "5512345678"
        },
        "customerId": {
            "description": "Unique identifier for the customer",
            "type": "string",
            "example": "109876542371"
        },
        "legalRepresentativeId": {
            "description": "Unique identifier for corporate legal Representative. Only for Corporate customers",
            "type": "string",
            "example": "1",
            "maxLength": 2
        },
        "encryptedDeleteDevice": {
            "description": "Encrypted object as defined in the definitions swagger.",
            "type": "string",
            "format": "byte",
            "example": "Q34EDR56TF"
        }
    },
    "required": [
        "phoneNumber",
        "customerId",
        "encryptedDeleteDevice"
    ]
}
              

DeleteDeviceResponse

{
    "type": "object",
    "properties": {
        "responses": {
            "type": "array",
            "items": {
                "$ref": "#/definitions/Response"
            }
        }
    },
    "required": [
        "responses"
    ]
}
              

DeleteDeviceInfoResponse

{
    "type": "object",
    "properties": {
        "responses": {
            "type": "array",
            "items": {
                "$ref": "#/definitions/Response"
            }
        }
    },
    "required": [
        "responses"
    ]
}
              

Response

{
    "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"
    ]
}
              

ErrorResponse

{
    "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"
    ]
}