--- swagger: "2.0" info: title: crds-ccc-v-debit-card-report description: This microservice is used to do the report of a debit card when it is stolen/lost or damaged etc. and request the generation of information of a new card to replace it version: 1.0.0 x-ibm-name: crds-ccc-v-debit-card-report host: 127.0.0.1 schemes: - https basePath: /api produces: - application/json paths: /v1/cards/debit-card/reports/retrieve: post: tags: - retrieve-new-debit-card operationId: retrieve-new-debit-card summary: 'LOB: Cards, Feature: Debit Card information , Functionality:report and retrieve new debit card information' description: This API is used to report a debit card when is stolen/lost/fraud and retrieve the information of the new debit card 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: 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: sid in: header required: true type: string description: SessionId sent by Consumer - name: retrieveNewDebitCardRequest in: body schema: $ref: '#/definitions/RetrieveNewDebitCardRequest' responses: 200: description: Successful operation. schema: $ref: '#/definitions/RetrieveNewDebitCardResponse' 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: RetrieveNewDebitCardRequest: type: object properties: cardIssue: $ref: '#/definitions/CardIssue' required: - cardIssue CardIssue: type: object properties: customerId: description: Customer ID is a key associated with a specific entity or person Citi does business or has some relationship with type: string pattern: ^[0-9]{5,12}$ minLength: 5 maxLength: 12 example: "123456789012" accountId: description: Unique ID used by front end to identify the account type: string example: "123456" reportTypeCode: description: 'Code to indicate the type of the report. Values: Lost and Stolen request (Request flag = T), Damage Card Replacement (Request flag = R), Blocking request (Request flag = B), Other request (Request flag = Z).' type: string example: T cardBlockCode: description: Card block Codes.(L - Lost&Stolen) (F - Fraud) Possibles values are in AMCR file (AMCR-LB-LM-BLK). type: string example: L blockReasonCode: description: 'The reason for blocking the card. For eg: (01 - Lost Card, 02 - Stolen Card) The card is stolen while travelling.' type: string example: "01" feeCode: description: Code to indicate how the replacement need to be payed. Valid values are B, N, Y and U type: string example: B replacementReasonCode: description: Reason of the replacement of the card. Possible values E, O, B, G, U type: string example: E required: - customerId - accountId - reportTypeCode - cardBlockCode - feeCode - replacementReasonCode RetrieveNewDebitCardResponse: type: object properties: reportReferenceNumber: description: Unique Id to identify the report. It is generated by the folio report service used for tracking. type: string example: 05235e5da96d000001 cardPlastic: $ref: '#/definitions/CardPlastic' customerAddress: $ref: '#/definitions/customerAddress' required: - reportReferenceNumber - cardPlastic - customerAddress CardPlastic: type: object properties: displayCardNumber: description: The last 4 digits of the new card number. type: string example: "3523" required: - displayCardNumber customerAddress: type: object properties: postalCode: description: Postal code of the customer address. type: string example: "06500" colonyName: description: Colony information of the customer address type: string example: Cuauhtemoc lastUpdatedDate: description: Last time the customer address was updated type: string format: date example: "2018-02-02" maxLength: 10 required: - postalCode - colonyName - lastUpdatedDate 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 security: - OAuth2 Application Flow: - /api/v1 ClientID: [] 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 ClientID: type: apiKey description: "" in: header name: X-IBM-Client-Id x-ibm-endpoints: - endpointUrl: https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext type: - production - development ...