production
development
https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext
Paths
/v1/cards/debit-card/reports/retrieve
post /v1/cards/debit-card/reports/retrieve
retrieve-new-debit-card
LOB: Cards, Feature: Debit Card information , Functionality:report and retrieve new debit card information
This API is used to report a debit card when is stolen/lost/fraud and retrieve the information of the new debit card
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
ClientID
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
retrieveNewDebitCardRequest
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/debit-card/reports/retrieve
Definitions
{
"type": "object",
"properties": {
"cardIssue": {
"$ref": "#/definitions/CardIssue"
}
},
"required": [
"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"
]
}
{
"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"
]
}
{
"type": "object",
"properties": {
"displayCardNumber": {
"description": "The last 4 digits of the new card number.",
"type": "string",
"example": "3523"
}
},
"required": [
"displayCardNumber"
]
}
{
"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"
]
}
{
"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"
]
}