--- swagger: "2.0" info: title: crds-cnf-d-card-provisioning description: This microservice is used to manage information in the S111 about provisioning request for card plastics version: 1.0.0 x-ibm-name: crds-cnf-d-card-provisioning host: 127.0.0.1 basePath: /api schemes: - https produces: - application/json paths: /v1/cards/provisioning-requests: post: tags: - create-card-provisioning-requests operationId: create-card-provisioning-requests summary: 'LOB: OD&T; Feature: Card Plastic Provisioning Request; Functionality: Generate' description: This API is used to register a new provisioning request of card plastics for a branch or enterprise 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: countryCode in: header required: true type: string description: Country code in 2 character ISO 3166 format - name: businessCode in: header required: true type: string description: Business code identified during application registration - 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: createCardProvisioningRequest in: body required: true schema: $ref: '#/definitions/CreateCardProvisioningRequest' responses: 200: description: Successful operation. schema: $ref: '#/definitions/CreateCardProvisioningResponse' 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' put: tags: - update-card-provisioning-requests operationId: update-card-provisioning-requests summary: 'LOB: OD&T; Feature: Plastic Card Provisioning Request; Functionality: Modify' description: This api is used to modify information or cancel the card plastic provisioning request 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: countryCode in: header required: true type: string description: Country code in 2 character ISO 3166 format - name: businessCode in: header required: true type: string description: Business code identified during application registration - 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: updateCardProvisioningRequest in: body required: true schema: $ref: '#/definitions/UpdateCardProvisioningRequest' responses: 204: description: Successful operation. 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' /v1/cards/provisioning-requests/retrieve: post: tags: - retrieve-card-provisioning-requests operationId: retrieve-card-provisioning-requests summary: 'LOB: OD&T; Feature: Card Plastic Provisioning Request; Functionality: Retrieve' description: This API is used to retrieve the daily card plastic provisioning requests 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: countryCode in: header required: true type: string description: Country code in 2 character ISO 3166 format - name: businessCode in: header required: true type: string description: Business code identified during application registration - 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: retrieveCardProvisioningRequest in: body required: true schema: $ref: '#/definitions/RetrieveCardProvisioningRequest' responses: 200: description: Successful operation. schema: $ref: '#/definitions/RetrieveCardProvisioningResponse' 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' /v1/cards/provisioning-requests/status: put: tags: - update-provisioning-requests-status operationId: update-provisioning-requests-status summary: 'LOB: OD&T; Feature: Card Plastic Provisioning Request Status; Functionality: Modify' description: This API is used to update the card plastic provisioning request consigments status to mark them as authorized 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: countryCode in: header required: true type: string description: Country code in 2 character ISO 3166 format - name: businessCode in: header required: true type: string description: Business code identified during application registration - 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: updateProvisioningStatusRequest in: body required: true schema: $ref: '#/definitions/UpdateProvisioningStatusRequest' responses: 204: description: Successful operation. 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: CreateCardProvisioningRequest: type: object properties: cardProvisioning: type: array minItems: 1 maxItems: 18 items: $ref: '#/definitions/CardProvisioningData' CreateCardProvisioningResponse: type: object properties: provisioningReferenceNumber: description: Reference number generated by TS&CO container to identify the provisioning request type: string maxLength: 6 example: "705862" required: - provisioningReferenceNumber RetrieveCardProvisioningRequest: type: object properties: requestTypeCode: description: Type of request to filter (Automatic or Special) type: string maxLength: 1 example: "1" productCode: description: 'Product line related with the type of card: excecutive profile payroll, Debit in branch, Profile debit in branch, Priority Debit in branch' type: string maxLength: 2 example: "02" bankIdentificationNumber: description: Card number Bin related to the provisioning of the requested plastic cards type: string maxLength: 6 example: "881052" sirh: description: sirh of the branch where was required the provisioning type: string maxLength: 4 example: "1970" organizationId: description: Identifier of the enterprise that required the provisioning type: string maxLength: 16 example: "0000000000000045" requestStatusCode: description: Status for the requests to inquiry, can be 00-All status, 01-Pendients, 02-Authorized, 03-Canceled type: string maxLength: 2 example: "03" provisioningReferenceNumber: description: Reference number generated by TS&CO container to identify the provisioning request type: string maxLength: 6 example: "705862" productSerialNumber: description: Identifier that is related to the reference number and depends on the number of types of product that are required for the provisioning type: string maxLength: 4 example: "0001" RetrieveCardProvisioningResponse: type: object properties: cardProvisioning: type: array minItems: 1 maxItems: 100 items: $ref: '#/definitions/CardProvisioning' moreInformationIndicator: description: Indicator of end of registers to receive from S054. type: string example: S maxLength: 1 required: - cardProvisioning - moreInformationIndicator UpdateProvisioningStatusRequest: type: object properties: cardProvisioning: type: array minItems: 1 maxItems: 63 items: $ref: '#/definitions/CardProvisioningInformation' UpdateCardProvisioningRequest: type: object properties: cardProvisioning: type: array minItems: 1 maxItems: 10 items: $ref: '#/definitions/CardProvisioningDetail' CardProvisioningData: type: object properties: provisioningReferenceNumber: description: Reference number generated by TS&CO container to identify the provisioning request type: string maxLength: 6 example: "705862" productSerialNumber: description: Identifier that is related to the reference number and depends on the number of types of product that are required for the provisioning type: string maxLength: 4 example: "0001" sirh: description: sirh of the branch where was required the provisioning type: string maxLength: 4 example: "1970" organizationId: description: Identifier of the enterprise that required the provisioning type: string maxLength: 16 example: "0000000000000045" organizationBranchId: description: Identifier of the branch that belongs to an organization where pre-registration request will be managed type: string maxLength: 16 example: 0000000000004967 lastUpdatedDate: description: Last Date that indicates when the provisioning request was updated type: string format: date maxLength: 10 example: "2021-10-20" bankIdentificationNumber: description: Card number Bin related to the provisioning of the requested plastic cards type: string maxLength: 6 example: "881052" organizationStructureCode: description: This is an attribute that helps to indentify if the client is a member of some civil asociation or a non-profit group, Ex 0000-None type: string maxLength: 4 example: "0000" cardPlasticId: description: Type or design of the plastic card required for the provisioning type: string maxLength: 2 example: "01" cardUsageCode: description: 'It helps to identify what the card provisioning request is destined for: sell, change or corporative' type: string example: "01" maxLength: 2 cardRequestedCount: description: Amount of plastic cards(by product) requested type: integer format: int32 example: 20 minimum: 1 maximum: 9999 payrollId: description: Payroll of the executive who made the provisioning request type: string maxLength: 12 example: 000090752205 required: - productSerialNumber - lastUpdatedDate - bankIdentificationNumber - cardRequestedCount - payrollId CardProvisioning: type: object properties: requestDate: description: Date that indicates when the provisioning request was created in format aaaa-mm-dd type: string format: date maxLength: 10 example: "2021-10-20" organizationStructureCode: description: This is an attribute that helps to indentify if the client is a member of some civil asociation or a non-profit group, Ex 0000-None type: string maxLength: 4 example: "0000" cardUsageCode: description: 'It helps to identify what the card provisioning request is destined for: sell, change or corporative' type: string example: "01" maxLength: 2 payrollId: description: Payroll of the executive who made the provisioning request type: string example: 000090752205 maxLength: 12 cardRequestedCount: description: Amount of plastic cards(by product) requested type: integer format: int32 example: 20 minimum: 1 maximum: 9999 cardPlasticId: description: Type or design of the plastic card required for the provisioning type: string example: "01" maxLength: 2 organizationBranchId: description: Identifier of the branch that belongs to an organization where pre-registration request will be managed type: string maxLength: 16 example: 0000000000004967 requestTypeCode: description: Type of request to filter (Automatic or Special) type: string example: A maxLength: 1 bankIdentificationNumber: description: Card number Bin related to the provisioning of the requested plastic cards type: string example: "881052" maxLength: 6 sirh: description: sirh of the branch where was required the provisioning type: string example: "1970" maxLength: 4 organizationId: description: Identifier of the enterprise that required the provisioning type: string example: "0000000000000045" maxLength: 16 requestStatusCode: description: Status for the requests to inquiry, can be 00-All status, 01-Pendients, 02-Authorized, 03-Canceled type: string example: "03" maxLength: 2 provisioningReferenceNumber: description: Reference number generated by TS&CO container to identify the provisioning request type: string example: "705862" maxLength: 6 productSerialNumber: description: Identifier that is related to the reference number and depends on the number of types of product that are required for the provisioning type: string example: "0001" maxLength: 4 required: - requestTypeCode - provisioningReferenceNumber - productSerialNumber - bankIdentificationNumber - cardRequestedCount - requestStatusCode - payrollId - requestDate CardProvisioningDetail: type: object properties: provisioningReferenceNumber: description: Reference number generated by TS&CO container to identify the provisioning request type: string example: "705862" maxLength: 6 productSerialNumber: description: Identifier that is related to the reference number and depends on the number of types of product that are required for the provisioning type: string example: "0024" maxLength: 4 sirh: description: sirh of the branch where was required the provisioning type: string example: "1970" maxLength: 4 organizationId: description: Identifier of the enterprise that required the provisioning type: string example: 0000028804220011 maxLength: 16 organizationBranchId: description: Identifier of the branch that belongs to an organization where pre-registration request will be managed type: string maxLength: 16 example: 0000000000004967 lastUpdatedDate: description: Last Date that indicates when the provisioning request was updated type: string format: date example: "2017-07-21" maxLength: 10 bankIdentificationNumber: description: Card number Bin related to the provisioning of the requested plastic cards type: string example: "520694" maxLength: 6 organizationStructureCode: description: This is an attribute that helps to indentify if the client is a member of some civil asociation or a non-profit group, Ex 0000-None type: string example: "0000" maxLength: 4 cardPlasticId: description: Type or design of the plastic card required for the provisioning type: string example: "01" maxLength: 2 cardUsageCode: description: 'It helps to identify what the card provisioning request is destined for: sell, change or corporative' type: string example: "01" maxLength: 2 cardRequestedCount: description: Amount of plastic cards(by product) requested type: integer format: int32 example: 15 minimum: 1 maximum: 9999 approverId: description: Identifier of the approver who authorized the provisioning request type: string example: 000090752205 maxLength: 12 requestStatusCode: description: Status for the requests to inquiry, can be 00-All status, 01-Pendients, 02-Authorized, 03-Canceled type: string example: "03" maxLength: 2 cancelReason: description: Free text with the wording of the justification that the user captures when he cancels a request. type: string example: Not applicable for this particular work unit. maxLength: 60 required: - provisioningReferenceNumber - productSerialNumber - lastUpdatedDate - bankIdentificationNumber - cardRequestedCount - approverId - requestStatusCode CardProvisioningInformation: type: object properties: requestTypeCode: description: Type of request to filter (Automatic or Special) type: string example: A maxLength: 1 provisioningReferenceNumber: description: Reference number generated by TS&CO container to identify the provisioning request type: string example: "705862" maxLength: 6 productSerialNumber: description: Identifier that is related to the reference number and depends on the number of types of product that are required for the provisioning type: string example: "0001" maxLength: 4 requestStatusCode: description: Status for the requests to inquiry, can be 00-All status, 01-Pendients, 02-Authorized, 03-Canceled type: string example: "03" maxLength: 2 approverId: description: Identifier of the approver who authorized the provisioning request type: string example: 000090752205 maxLength: 12 required: - requestTypeCode - provisioningReferenceNumber - productSerialNumber - requestStatusCode - approverId 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: URI to human readable documentation 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 x-ibm-configuration: enforced: true testable: true phase: realized 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 ...