---
swagger: "2.0"
info:
title: crds-ccc-v-card-management
description: This microservice is used to block or unblock the debit or credit card
depending on the code.
version: 1.0.0
x-ibm-name: crds-ccc-v-card-management
host: 127.0.0.1
schemes:
- https
basePath: /api
produces:
- application/json
paths:
/v1/cards/status/detail:
put:
tags:
- update-cards-status-detail
operationId: update-cards-status-detail
summary: LOB:Cards; Feature:Debit and Credit Cards; Functionality:Update Status
description: This API depending on the classification decides if it is a debit
or credit card, it will block or unblock depending the code of the request.
consumes:
- application/json
produces:
- application/json
parameters:
- name: client_id
in: header
required: false
type: string
description: Client ID generated during application registration
- name: Authorization
in: header
required: false
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: updateCardsStatusRequest
in: body
schema:
$ref: '#/definitions/UpdateCardsStatusRequest'
responses:
204:
description: Successful operation.
400:
description:
Type | Code | Details |
error | invalidRequest | Missing
or invalid Parameters |
schema:
$ref: '#/definitions/ErrorResponse'
401:
description: Type | Code | Details |
error | unAuthorized | Authorization
credentials are missing or invalid |
schema:
$ref: '#/definitions/ErrorResponse'
403:
description: 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 |
schema:
$ref: '#/definitions/ErrorResponse'
404:
description: Type | Code | Details | More
Info |
error | resourceNotFound | The requested
resource was not found | Empty resource/resource not found |
schema:
$ref: '#/definitions/ErrorResponse'
422:
description: Type | Code | Details | More
Info |
error | resourceNotFound | The requested
resource was not found | Empty resource/resource not found |
schema:
$ref: '#/definitions/ErrorResponse'
500:
description: Type | Code | Details |
fatal | serverUnavailable | The
request failed due to an internal error/server unavailability |
schema:
$ref: '#/definitions/ErrorResponse'
definitions:
UpdateCardsStatusRequest:
type: object
properties:
accountId:
description: AccountId will be an ID used to represent an account number uniquely.
type: string
example: "123456"
customerId:
description: Customer ID is a key associated with a specific entity or person
Citi does business or has some relationship with.
type: string
example: "123456789012"
pattern: ^[0-9]*$
maxLength: 12
cardStatusCode:
description: Code that the customer provides to block or unblock the card.
type: string
pattern: '[LYFS]'
example: L
maxLength: 1
blockReasonCode:
description: Block reason code gives more specific reason for blocking the
account
type: string
pattern: '[YU0-9]{2}'
example: Y1
maxLength: 2
required:
- accountId
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 or detailed description 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
...