production
development
https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext
Paths
/v1/cards/customers/notes/info/save
post /v1/cards/customers/notes/info/save
save-customer-card-note-info
LOB: Cards, Feature: Debit and Credit Card, Functionality: Add Notes
This API is used by the agent to add notes that customer provides regarding the cards.
OAuth2 Application Flow
OAuth2 Application Flow
(oauth2 application)
Token URL
https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext/api/v1/oauth/token
Scopes
/api/v1
Client ID
X-IBM-Client-Id
(apiKey located in header)
client_id
Required in header
string
Client ID generated during application registration
Authorization
Required in header
string
The Authorization Token received during login
Accept
Required in header
string
Content-Types that are acceptable for the response
uuid
Required in header
string
128 bit UUID that you generate for every request
Accept-Language
Optional in header
string
List of acceptable human languages for response
Content-Type
Required in header
string
Content-Types that are sent in the request
ChannelId
Required in header
string
Channel where request originated
countryCode
Required in header
string
Country code in 2 character ISO 3166 format
businessCode
Required in header
string
Business code identified during application registration
sid
Required in header
string
SessionId sent by Consumer
saveCustomerCardNoteInfoRequest
Optional in body
object
200
Successful operation.
400
| Type | Code | Details |
| error | invalidRequest | Missing or invalid Parameters |
401
| Type | Code | Details |
| error | unAuthorized | Authorization credentials are missing or invalid |
403
| 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 |
404
| Type | Code | Details | More Info |
| error | resourceNotFound | The requested resource was not found | Empty resource/resource not found |
422
| Type | Code | Details |
| error | businessValidationFailed | Business validation error occured on one or more parameters |
500
| Type | Code | Details |
| fatal | serverUnavailable | The request failed due to an internal error/server unavailability |
Example Request
Example Response
POST https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext/api/v1/cards/customers/notes/info/save
/v1/cards/customers/notes/info/retrieve
post /v1/cards/customers/notes/info/retrieve
retrieve-customer-card-note-info
LOB: Cards, Feature: Debit and Credit Card, Functionality: Retrieve-notes
This API is used by the agent to read the notes that a customer provides regarding the cards.
OAuth2 Application Flow
OAuth2 Application Flow
(oauth2 application)
Token URL
https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext/api/v1/oauth/token
Scopes
/api/v1
Client ID
X-IBM-Client-Id
(apiKey located in header)
client_id
Optional in header
string
Client ID generated during application registration
Authorization
Optional in header
string
The Authorization Token received during login
Accept
Required in header
string
Content-Types that are acceptable for the response
uuid
Required in header
string
128 bit UUID that you generate for every request
Accept-Language
Optional in header
string
List of acceptable human languages for response
Content-Type
Required in header
string
Content-Types that are sent in the request
ChannelId
Required in header
string
Channel where request originated
countryCode
Required in header
string
Country code in 2 character ISO 3166 format
businessCode
Required in header
string
Business code identified during application registration
sid
Required in header
string
SessionId sent by Consumer
customerCardNoteInfoRequest
Optional in body
object
200
Successful operation.
400
| Type | Code | Details |
| error | invalidRequest | Missing or invalid Parameters |
401
| Type | Code | Details |
| error | unAuthorized | Authorization credentials are missing or invalid |
403
| 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 |
404
| Type | Code | Details | More Info |
| error | resourceNotFound | The requested resource was not found | Empty resource/resource not found |
422
| Type | Code | Details |
| error | businessValidationFailed | Business validation error occured on one or more parameters |
500
| Type | Code | Details |
| fatal | serverUnavailable | The request failed due to an internal error/server unavailability |
Example Request
Example Response
POST https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext/api/v1/cards/customers/notes/info/retrieve
Definitions
{
"type": "object",
"properties": {
"agentId": {
"description": "SOE id of Agent who registers the card note",
"type": "string",
"pattern": "^[a-zA-Z0-9]*$",
"example": "jp34651"
},
"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"
},
"cardPlastic": {
"$ref": "#/definitions/CardPlastic"
}
},
"required": [
"agentId",
"accountId",
"customerId"
]
}
{
"type": "object",
"properties": {
"responseCode": {
"description": "Code of the Response received from backend.",
"type": "string",
"example": "101",
"maxLength": 3
}
},
"required": [
"responseCode"
]
}
{
"type": "object",
"properties": {
"agentId": {
"description": "SOE id of Agent who registers the card note",
"type": "string",
"pattern": "^[a-zA-Z0-9]*$",
"example": "jp34651"
},
"cardPlastic": {
"$ref": "#/definitions/CardPlasticInfo"
}
},
"required": [
"agentId"
]
}
{
"type": "object",
"properties": {
"recordCount": {
"description": "Number of total records received so far in the query.",
"type": "integer",
"format": "int32",
"example": 12
},
"transactionResponseReasonCode": {
"description": "Code refers to the reason for the status of transaction's authorization.",
"type": "string",
"maxLength": 3,
"example": "123"
},
"noteDetails": {
"type": "array",
"items": {
"$ref": "#/definitions/NoteDetailInfo"
}
}
}
}
{
"type": "object",
"properties": {
"notes": {
"$ref": "#/definitions/Notes"
}
}
}
{
"type": "object",
"properties": {
"account": {
"$ref": "#/definitions/Account"
},
"notes": {
"$ref": "#/definitions/NotesInfo"
}
}
}
{
"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"
}
},
"required": [
"customerId",
"accountId"
]
}
{
"type": "object",
"properties": {
"noteType": {
"description": "Type of note created to clasify the reason of operation for debit card.",
"type": "string",
"pattern": "^[a-zA-Z0-9]*$",
"example": "1",
"maxLength": 3
},
"noteStatusCode": {
"description": "The current status of the note to indicate if note is open or close.",
"type": "string",
"pattern": "[CO]",
"example": "C",
"maxLength": 1
},
"noteDetails": {
"type": "array",
"items": {
"$ref": "#/definitions/NoteDetail"
}
}
},
"required": [
"noteType",
"noteStatusCode"
]
}
{
"type": "object",
"properties": {
"noteText": {
"description": "Comments entered during the ongoing research or investigation of case.",
"type": "string",
"pattern": ".*",
"example": "Card blocked for security purposes",
"maxLength": 60
}
},
"required": [
"noteText"
]
}
{
"type": "object",
"properties": {
"noteType": {
"description": "Type of note created to clasify the reason of operation for debit card.",
"type": "string",
"pattern": "^[a-zA-Z0-9]*$",
"example": "1",
"maxLength": 3
},
"queryMonthCode": {
"description": "Code used to specify the month to be consulted. Eg. 01 = January",
"type": "string",
"pattern": "^[a-zA-Z0-9]*$",
"example": "01",
"maxLength": 2
}
}
}
{
"type": "object",
"properties": {
"noteText": {
"description": "Description of the case like providing brief summary of the issue faced by the customer.",
"type": "string",
"pattern": ".*",
"example": "Card blocked for security purposes",
"maxLength": 60
},
"noteType": {
"description": "Type of note created to clasify the reason of operation for card. Type of case for example lost of card etc.",
"type": "string",
"pattern": "^[a-zA-Z0-9]*$",
"example": "1",
"maxLength": 3
},
"noteStatusCode": {
"description": "The current status of the note to indicate if note is open or close.",
"type": "string",
"pattern": "[CO]",
"example": "C",
"maxLength": 1
},
"agentId": {
"description": "SOE id of Agent who registers the card note",
"type": "string",
"pattern": "^[a-zA-Z0-9]*$",
"example": "jp34651"
},
"noteDate": {
"description": "Refers to the system date and time when the actual transaction was executed for an account.",
"type": "string",
"format": "date-time",
"example": "2022-06-22T19:02:30Z"
}
}
}
{
"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"
]
}