production
development
https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext
Paths
/v1/cards/credit-cards/retrieve
post /v1/cards/credit-cards/retrieve
credit-card-detail
LOB:Cards; Feature:Credit-Cards-Management; Functionality:Card-Details
This API is used to retrieve the credit card information for the customer.
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
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"
}sid
Required in header
string
SessionId sent by Consumer
retrieveCreditCardRequest
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/credit-cards/retrieve
Definitions
{
"type": "object",
"properties": {
"customerId": {
"description": "Unique identifier of the customer.",
"type": "string",
"example": "123456789012",
"pattern": "^[0-9]*$",
"maxLength": 12
},
"cardNumber": {
"description": "Number Embossed/ Printed on the Card",
"type": "string",
"example": "1234567890123456",
"pattern": "^[0-9]*$",
"maxLength": 16
},
"expiryDateValidationFlag": {
"description": "Flag that indicates if the API will retrieve the valid expiry date or not",
"type": "boolean",
"example": true
}
},
"required": [
"customerId"
]
}
{
"type": "object",
"properties": {
"cardPlastic": {
"type": "array",
"items": {
"$ref": "#/definitions/CardPlastic"
}
}
},
"required": [
"cardPlastic"
]
}
{
"type": "object",
"properties": {
"activationDate": {
"description": "The date when the card plastic is activated. Tdahe date is captured in ISO 8601, YYYY-MM-DD format.",
"type": "string",
"format": "date",
"example": "2020-04-14"
},
"activationIndicator": {
"description": "Indicator of the activation status of the physical plastic card (N: Not Active, Y: Active, D: Dormand, B:Blocked).",
"type": "string",
"example": "Y"
},
"cardBlockCode": {
"description": "The block code used to block a particular card.",
"type": "string",
"example": "Blocked"
},
"cardNickName": {
"description": "Nick name of the card.",
"type": "string",
"example": "Card"
},
"cardNumber": {
"description": "Number Embossed/ Printed on the Card.",
"type": "string",
"example": "1234567890123456"
},
"cardStatus": {
"description": "Status of the Card.",
"type": "string",
"example": "Active"
},
"expiryDate": {
"description": "The date on which the card becomes invalid/expired.",
"type": "string",
"format": "date",
"example": "2020-09-22"
},
"previousActivationIndicator": {
"description": "Indicator of the activation status of the previous physical plastic card (N: Not Active, Y: Active, D: Dormand, B:Blocked).",
"type": "string",
"example": "Y"
},
"previousExpiryDate": {
"description": "The date of previous card when it becomes invalid/expired.",
"type": "string",
"format": "date",
"example": "2017-09-22"
},
"validExpiryDate": {
"description": "expiry date identified as valid at the moment of the request that should be used for purchasing (considering a possible replacement process)",
"type": "string",
"format": "date",
"example": "2017-09-22"
},
"newCardNumber": {
"description": "Number Embossed/ Printed on the new replaced Card (either theft, loss or fraud report).",
"type": "string",
"example": "9984567890123456"
},
"cardHolderType": {
"description": "Identifies the type of card user such as Primary, Secondary, Owner, Employee",
"type": "string",
"example": "P"
},
"lastPurchaseAuthorizationDate": {
"description": "Date of the last purchase or transaction authorized for this card. Date in ISO 8601, YYYY-MM-DD format",
"type": "string",
"format": "date",
"example": "2017-09-22"
},
"lastTransactionPostingDate": {
"description": "Refers to the date on which last transaction has been posted for this card. Date in ISO 8601, YYYY-MM-DD format",
"type": "string",
"format": "date",
"example": "2017-09-22"
},
"availableBalanceAmount": {
"description": "Sum of all debit and credit transactions (amount) in cycle for this card",
"type": "number",
"format": "double",
"example": 2500.22
},
"cardPlasticId": {
"description": "Unique Identifier of the plastic card",
"type": "string",
"example": "234"
},
"account": {
"$ref": "#/definitions/Account"
}
},
"required": [
"account"
]
}
{
"type": "object",
"properties": {
"customerId": {
"description": "Unique identifier of the customer.",
"type": "string",
"example": "123456789012"
},
"accountNumber": {
"description": "Customer's Account Number with the Bank.",
"type": "string",
"example": "123456789012"
},
"accountStatus": {
"description": "Status of the Account.",
"type": "string",
"example": "Active"
},
"blockCode": {
"description": "Block code specifies the scenario on which the account is blocked.",
"type": "string",
"example": "1234"
},
"additionalBlockCode": {
"description": "Block code specifies the additional scenario on which the account is blocked.",
"type": "string",
"example": "1234"
},
"creditLimitAmount": {
"description": "It represents Credit limit amount on the card account.",
"type": "number",
"format": "double",
"example": 5500.55
},
"currencyCode": {
"description": "The currency code identifier of the account",
"type": "string",
"example": "MXN"
},
"lastStatementBalanceAmount": {
"description": "Last statement closing balance. Indicates the amount owed at the time of statement generation.",
"type": "number",
"format": "double",
"example": 4500.55
},
"outstandingBalanceAmount": {
"description": "Total outstanding balance amount to be repaid. This is the amount that card holder needs to pay every month as against his loan taken on credit card.",
"type": "number",
"format": "double",
"example": 3500.55
},
"paymentDueDate": {
"description": "Date on which the payment is due.",
"type": "string",
"format": "date",
"example": "2020-07-25"
},
"productCode": {
"description": "Unique code that identifies the product.",
"type": "string",
"example": "1234"
},
"productName": {
"description": "Name of the product.",
"type": "string",
"example": "Credit Card"
},
"currentStatementBalanceAmount": {
"description": "Current statement closing balance. Indicates the amount owed at the time of statement generation.",
"type": "number",
"format": "double",
"example": 5000.55
},
"lastPaymentDate": {
"description": "The date of most recent payment on the account.",
"type": "string",
"format": "date",
"example": "2020-05-23"
}
}
}
{
"required": [
"code",
"details",
"location",
"moreInfo",
"timestamp",
"type"
],
"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": {
"type": "string",
"description": "Error code which qualifies the error"
},
"details": {
"type": "string",
"description": "Human readable explanation specific to the occurrence of the problem"
},
"location": {
"type": "string",
"description": "The name of the field that resulted in the error"
},
"moreInfo": {
"type": "string",
"description": "URI to human readable documentation of the error"
},
"timestamp": {
"type": "string",
"description": "Timestamp of the error"
}
}
}