--- swagger: "2.0" info: title: CSMT-CRM-D-CodiBanxicoEnrollement description: The Microservice is used for enrollment of CODi app with Banxico using Banamex App version: 1.0.0 x-ibm-name: csmt-crm-d-codibanxicoenrollement host: 127.0.0.1 schemes: - https basePath: /api produces: - application/json paths: /v1/customers/codi-banxico/enrollment: post: tags: - codi-banxico-enrollment operationId: codi-banxico-enrollment summary: The API is is used for enrollment of CODi app with Banxico using Banamex App description: The API is is used for enrollment of CODi app with Banxico using Banamex App consumes: - application/json produces: - application/json parameters: - name: client_id in: header required: true type: string description: Client ID generated during application registration - name: Authorization in: header required: true type: string description: The Authorization Token received during login - name: Accept in: header required: true type: string description: Content-Types that are acceptable for the response - name: uuid in: header required: true type: string description: 128 bit UUID that you generate for every request - name: Accept-Language in: header required: false type: string description: List of acceptable human languages for response - name: Content-Type in: header required: true type: string description: Content-Types that are sent in the request - name: ChannelId in: header required: true type: string description: Channel where request originated - name: sid in: header required: true type: string description: SessionId sent by Consumer - name: codiBanxicoEnrollmentRequest in: body schema: $ref: '#/definitions/CodiBanxicoEnrollmentRequest' responses: 200: description: Successful operation. schema: $ref: '#/definitions/CodiBanxicoEnrollmentResponse' 400: description:
TypeCodeDetails
errorinvalidRequestMissing or invalid Parameters
schema: $ref: '#/definitions/ErrorResponse' 401: description:
TypeCodeDetails
errorunAuthorizedAuthorization credentials are missing or invalid
schema: $ref: '#/definitions/ErrorResponse' 403: description:
TypeCodeDetailsMore Info
erroraccessNotConfiguredThe request operation is not configured to access this resourceChannel/Country/Business provided in the request is not supported currently
schema: $ref: '#/definitions/ErrorResponse' 404: description:
TypeCodeDetailsMore Info
errorresourceNotFoundThe requested resource was not foundEmpty resource/resource not found
schema: $ref: '#/definitions/ErrorResponse' 422: description:
TypeCodeDetails
errorbusinessValidationFailedBusiness validation error occured on one or more parameters
schema: $ref: '#/definitions/ErrorResponse' 500: description:
TypeCodeDetails
fatalserverUnavailableThe request failed due to an internal error/server unavailability
schema: $ref: '#/definitions/ErrorResponse' definitions: CodiBanxicoEnrollmentRequest: 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 Device: 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 CodiBanxicoEnrollmentResponse: 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 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 x-ibm-configuration: enforced: true testable: true phase: realized consumes: - application/json securityDefinitions: OAuth2 Application Flow: type: oauth2 description: "" flow: application scopes: /api/v1: "" tokenUrl: https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext/api/v1/oauth/token Client ID: type: apiKey description: "" in: header name: X-IBM-Client-Id security: - OAuth2 Application Flow: - /api/v1 Client ID: [] x-ibm-endpoints: - endpointUrl: https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext type: - production - development ...