production
development
https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext
Paths
/v1/cards/products-data/retrieve
post /v1/cards/products-data/retrieve
retrieve-card-product-data
LOB:Cards; Feature: Card Product; Functionality:Retrieve
This API requires a customer identification and card number to retrieve the confirmation response of the grant or deny customer access according to the card products.
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
uuid
Required in header
string
128 bit UUID that you generate for every request
Accept
Required in header
string
Content-Types that are acceptable for the response
Accept-Language
Optional in header
string
List of acceptable human languages for response
{
"default": "es"
}ChannelId
Required in header
string
Channel where request originated
Content-Type
Required in header
string
Content-Types that are sent in the request
{
"default": "application\/json"
}countryCode
Required in header
string
Country code in 2 character ISO 3166 format
{
"default": "MX"
}businessCode
Required in header
string
Business code identified during application registration
{
"default": "GCB"
}retrieveCardProductDataRequest
Required in body
object
200
Successful operation.
400
| Type | Code | Details |
| error | invalidRequest | Missing or invalid Parameters |
| error | cannotDecryptData | 620-Cannot decrypt, please re-check the encrypted value |
401
| Type | Code | Details |
| error | unAuthorized | Authorization credentials are missing or invalid |
403
| Type | Code | Details |
| error | accessNotConfigured | The request operation is not configured to access this resource |
| error | productNotAllowed | The card is not allowed to issue CVV2 and 2FA. |
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 |
| error | backendError | Failed during a call to backend service |
| error | timeoutError | Time to complete a transaction is over |
| 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/products-data/retrieve
Definitions
{
"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",
"example": "123456789012",
"pattern": "^[0-9]*$",
"maxLength": 12
},
"cardNumber": {
"description": "Card Number of the user.Redemption of points on demand can be availed using a unique card plastic. For eg: Creditcard,Debitcard.",
"type": "string",
"example": "123456789812"
}
},
"required": [
"customerId",
"cardNumber"
]
}
{
"type": "object",
"properties": {
"productCode": {
"description": "Unique code that identifies the product.",
"type": "string",
"example": "518"
},
"productName": {
"description": "Name by which the Product is known across enterprise.",
"type": "string",
"example": "CITI BEYOND"
},
"responseDescriptionFlag": {
"description": "Flag that indicates whether access has been granted or denied to the customer and if the system operation was succesful.",
"type": "boolean",
"example": false
},
"errorDescription": {
"description": "Error description when some customer data are missed.",
"type": "string",
"example": "CARD IS BLOCKED"
}
},
"required": [
"productCode",
"productName",
"responseDescriptionFlag"
]
}
{
"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"
]
}