production
development
https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext
Paths
/v1/cards/plastic/{customerId}
get /v1/cards/plastic/{customerId}
CardPlasticDetails
This API is to retrieve Customer Card Plastic Information
This API is to retrieve Customer Card Plastic Information. The scope of this API is Public, Entry-Point and Post-Login.
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)
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
Authorization
Required in header
string
The Authorization Token recieved during login
client_id
Required in header
string
Client ID generated during application registration
Content-Type
Required in header
string
Content-Types that are sent in the request
uuid
Required in header
string
128 bit UUID that you generate for every request
sid
Required in header
string
SessionId sent by Consumer
customerId
Required in path
string
Request body corresponding to get Card plastic details
fetchCardDetails
Required in query
string
Type of card details to be fetched Debit, Credit or Both
{
"enum": [
"CREDIT",
"DEBIT",
"BOTH"
]
}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 |
500
| Type | Code | Details |
| fatal | serverUnavailable | The request failed due to an internal error/server unavailability |
Example Request
Example Response
GET https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext/api/v1/cards/plastic/{customerId}
/v1/cards/plastic/pin
put /v1/cards/plastic/pin
CardPlasticPinSet
This API is to set Customer Card Plastic Pin
This API is to set Customer Card Plastic Pin
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)
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
Authorization
Required in header
string
The Authorization Token recieved during login
client_id
Required in header
string
Client ID generated during application registration
Content-Type
Required in header
string
Content-Types that are sent in the request
uuid
Required in header
string
128 bit UUID that you generate for every request
sid
Required in header
string
SessionId sent by Consumer
setCardPlasticPinRequest
Required in body
object
Request body corresponding to pin set for Card plastic
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 |
500
| Type | Code | Details |
| fatal | serverUnavailable | The request failed due to an internal error/server unavailability |
Example Request
Example Response
PUT https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext/api/v1/cards/plastic/pin
/v1/cards/plastic/e2ee/pin
put /v1/cards/plastic/e2ee/pin
card-plastic-e2ee-pinset
This API is for changing Customer Card Plastic PIN using E2E encryption
This API is for changing Customer Card Plastic PIN using E2E encryption
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
sid
Required in header
string
Sessionid value from E2EE Key Exchange response
cardPINChangeRequest
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
PUT https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext/api/v1/cards/plastic/e2ee/pin
Definitions
{
"properties": {
"encryptionKeyVersion": {
"description": "version of the encryption of key",
"type": "string",
"example": "2.0"
},
"cardPlasticDetails": {
"type": "array",
"items": {
"$ref": "#/definitions/CardPlasticDetails"
}
}
}
}
{
"properties": {
"cardNumber": {
"description": "Card Number belonging to the customer",
"type": "string",
"example": "1234567887654321"
},
"folioId": {
"description": "folio id generated",
"type": "string",
"example": "00001"
},
"pinChangeFlag": {
"description": "Pin change Flag",
"type": "boolean",
"example": true
},
"pinChangeMessage": {
"description": "Pin change Message",
"type": "string",
"example": "pin changes successfully"
}
}
}
Get Card Plastic Details
{
"type": "object",
"properties": {
"cardPlastic": {
"type": "array",
"items": {
"$ref": "#/definitions/CardPlastic"
}
},
"subCardType": {
"description": "Define if the customer has only Debit (D) or Credit (C) cards, or both (M)",
"type": "string",
"example": "M",
"maxLength": 1
}
},
"required": [
"cardPlastic"
]
}
{
"properties": {
"activationDate": {
"description": "activationDate",
"type": "string",
"format": "Date",
"example": "20171226"
},
"activationTimestamp": {
"description": "activation timestamp",
"type": "string",
"format": "Datetime",
"example": "1996-12-19T16:39:57-08:00"
},
"applicationInterchangeProfileValue": {
"description": "Application Inter change profile of the plastic. This information will be logged in cards host as part of authorization",
"type": "string",
"example": "5800"
},
"cardActivationIndicator": {
"type": "string",
"description": "Indicator for card active or inactive",
"example": "Y"
},
"cardLockedFlag": {
"description": "isCardLocked",
"type": "boolean",
"example": true
},
"cardNickname": {
"description": "cardNickname",
"type": "string",
"example": "Wife's Card"
},
"cardNumber": {
"description": "Card Number belonging to the customer",
"type": "string",
"example": "1234567887654321"
},
"cardDataStatus": {
"description": "status of data responded by backend",
"type": "string",
"example": "00"
},
"cardStatus": {
"description": "card Data Status",
"type": "string",
"example": "ACTIVE"
},
"cardType": {
"description": "Indicates whether the card is credit card or debit card",
"type": "string",
"enum": [
"CREDIT",
"DEBIT"
],
"example": "DEBIT"
},
"expiryDate": {
"description": "Expiry Date Of Card (Credit/Debit)",
"type": "string",
"format": "Date",
"example": "20171226"
},
"lastApplicationInterchangeProfile": {
"description": "The last AIP indicates which previous processing steps (e.g. cardholder verification, data authentication) are supported and which should be applied to the current transaction.",
"type": "string",
"example": "5800"
},
"lastCardActivationIndicator": {
"type": "string",
"description": "Last indicator for card active or inactive",
"example": "N"
},
"lastCardUpdateDate": {
"description": "last card updated date",
"type": "string",
"format": "Date",
"example": "20171226"
},
"lastExpiryDate": {
"description": "last expiry Date Of Card (Credit/Debit)",
"type": "string",
"format": "Date",
"example": "20171226"
},
"cardAccount": {
"$ref": "#/definitions/CardAccount"
},
"pinDetail": {
"$ref": "#/definitions/PinDetails"
}
},
"required": [
"cardAccount",
"pinDetail"
]
}
{
"properties": {
"customerId": {
"description": "unique identifier of the customer",
"type": "string",
"example": "00012312345"
},
"accountNumber": {
"description": "Account Number belonging to the customer",
"type": "string",
"example": "00012312345"
},
"accountStatus": {
"description": "status of the account",
"type": "string",
"example": "ACTIVE"
},
"creditLimitAmount": {
"description": "creditLimitAmount",
"type": "string",
"example": "45000"
},
"currencyCode": {
"description": "currencyCode",
"type": "string",
"example": "MXN"
},
"lastStatementBalanceAmount": {
"description": "lastStatementBalanceAmount",
"type": "string",
"example": "15000"
},
"minimumPaymentDueAmount": {
"description": "minimumPaymentDueAmount",
"type": "string",
"example": "15000"
},
"outstandingBalanceAmount": {
"description": "outstandingBalanceAmount",
"type": "string",
"example": "15000"
},
"paymentDueDate": {
"description": "paymentDueDate",
"type": "string",
"example": "20171226"
},
"productId": {
"description": "productId",
"type": "integer",
"example": 1234
},
"productName": {
"description": "product name",
"type": "string",
"example": "GOLD"
},
"productInstrument": {
"description": "productInstrument",
"type": "integer",
"example": 50
},
"accountCreationDate": {
"description": "registrationDate",
"type": "string",
"format": "Date",
"example": "20171226"
}
}
}
{
"properties": {
"cardPinOfflineStatus": {
"description": "Indicator to show card PIN Offline Status of the card",
"type": "string",
"example": "ACTIVE"
},
"lastCardPinOfflineStatus": {
"description": "Indicator to show last card PIN Offline Status of the card",
"type": "string",
"example": "ACTIVE"
},
"pinFailedCount": {
"description": "Count of wrong Pin entered",
"type": "number",
"format": "int",
"example": 2
},
"lastPinFailedCount": {
"description": "last count of wrong Pin entered",
"type": "number",
"format": "int",
"example": 2
},
"pinOfflineEnabledDate": {
"description": "Pin offline enable date",
"type": "string",
"format": "Date",
"example": "20171226"
},
"pinSynchronizationStatus": {
"description": "Whether the offline PIN and Online PIN is in sync for the plastic",
"type": "string",
"example": "1"
},
"pinSynchronizationDate": {
"description": "pinSynchronizationDate-DEBIT",
"type": "string",
"format": "Date",
"example": "20171226"
},
"pinSynchronizationTimestamp": {
"description": "pinSynchronizationHour-DEBIT",
"type": "string",
"format": "Datetime",
"example": "1996-12-19T16:39:57-08:00"
},
"lastPinSynchronizationStatus": {
"description": "Whether the last offline PIN and last Online PIN is in sync for the plastic",
"type": "string",
"example": "1"
}
}
}
{
"properties": {
"cardNumber": {
"description": "Card Number belonging to the customer",
"type": "string",
"example": "1234567887654321"
},
"cardType": {
"description": "Card Type decided in the microservice. Debit/Credit",
"type": "string",
"example": "DEBIT"
},
"accountDetails": {
"$ref": "#/definitions/AccountDetails"
},
"pinInformation": {
"$ref": "#/definitions/PinInformation"
}
},
"required": [
"accountDetails",
"pinInformation"
]
}
{
"properties": {
"customerId": {
"description": "Unique Identifier of the customer",
"type": "number",
"format": "int",
"example": 63743
}
}
}
{
"properties": {
"encryptedPinNumber": {
"description": "Pin number of the Card",
"type": "string",
"example": "3256"
},
"encryptedOldPinNumber": {
"description": "Old pin number of the Card",
"type": "string",
"example": "3562"
}
},
"required": [
"encryptedPinNumber"
]
}
{
"type": "object",
"properties": {
"encryptionTypeVersion": {
"description": "Version of the encryption key",
"type": "string",
"example": "1.0"
},
"cardPlastic": {
"$ref": "#/definitions/CardPlasticInformation"
}
},
"required": [
"encryptionTypeVersion"
]
}
{
"type": "object",
"properties": {
"cardNumber": {
"description": "Card number",
"type": "string",
"example": "4545232356561212",
"maxLength": 16,
"pattern": "^[0-9]{16}$"
},
"cardType": {
"description": "Card Type. Debit/Credit",
"type": "string",
"enum": [
"CREDIT",
"DEBIT"
]
},
"pin": {
"$ref": "#/definitions/PIN"
},
"account": {
"$ref": "#/definitions/Account"
}
},
"required": [
"cardNumber",
"cardType"
]
}
{
"type": "object",
"properties": {
"encryptedNewPINNumber": {
"description": "Encrypted PIN Value. This is encrypted by the frontends with the E2E encryption specifications shared trough POST /security/e2e/key API. The encoding used here should be HEX.",
"type": "string",
"example": "7E706C6D9555D765C247C068F95374F0"
},
"encryptedOldPINNumber": {
"description": "Encrypted PIN Value. This is encrypted by the frontends with the E2E encryption specifications shared trough POST /security/e2e/key API. The encoding used here should be HEX.",
"type": "string",
"example": "65C247C068F95374F07E706C6D9555D7"
}
},
"required": [
"encryptedNewPINNumber"
]
}
{
"type": "object",
"properties": {
"customerId": {
"description": "Customer Id",
"type": "string",
"example": "63743",
"maxLength": 16
}
},
"required": [
"customerId"
]
}
{
"type": "object",
"properties": {
"cardNumber": {
"description": "Card number",
"type": "string",
"example": "4545232356561212",
"maxLength": 16
},
"pinDetails": {
"$ref": "#/definitions/PINDetails"
}
},
"required": [
"cardNumber"
]
}
{
"type": "object",
"properties": {
"pinChangeFolioId": {
"description": "Folio generated by the PIN change process",
"type": "string",
"example": "98732"
},
"pinChangeStatus": {
"description": "Indicates if the PIN change process is done",
"type": "boolean",
"example": true
},
"pinChangeMessage": {
"description": "PIN change message",
"type": "string",
"example": "PIN changed successfully"
}
},
"required": [
"pinChangeStatus",
"pinChangeMessage"
]
}
{
"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"
]
}