production
development
https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext
Paths
/v1/cards/credit-cards/balance/retrieve
post /v1/cards/credit-cards/balance/retrieve
credit-card-balance
To retrieve all credit cards balance related to customer, web service client could choose between active or inactive cards, primary and supplementary cards, as part of the response indicates if the customer could have a premia rewards card.
This API is to retrieve all credit cards balance related to customer, web service client could choose between active or inactive cards, primary and supplementary cards, as part of the response indicates if the customer could have a premia rewards 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
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
sid
Optional in header
string
SessionId sent by Consumer
creditCardDetailsRequest
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/credit-cards/balance/retrieve
Definitions
{
"type": "object",
"properties": {
"customerId": {
"description": "Unique identifier of the customer",
"type": "string",
"example": "5491380012127370",
"maxLength": 16,
"minLength": 5
},
"cardType": {
"description": "Filter to define what card type (PRIMARY, SUPPLEMENTARY,BOTH) is expected.",
"type": "string",
"example": "PRIMARY",
"enum": [
"PRIMARY",
" SUPPLEMENTARY",
"BOTH"
]
},
"cardStatus": {
"description": "Filter to define what card status (ACTIVE,INACTIVE,BOTH) is expected.",
"type": "string",
"example": "ACTIVE",
"enum": [
"ACTIVE",
" INACTIVE",
"BOTH"
]
},
"creditCardDetail": {
"type": "array",
"items": {
"$ref": "#/definitions/CreditCardDetail"
}
}
},
"required": [
"customerId",
"cardType",
"cardStatus"
]
}
{
"type": "object",
"properties": {
"cardNumber": {
"description": "16 digit Card number of the credit card",
"type": "string",
"example": "1234567890123456",
"maxLength": 16,
"pattern": "^[0-9]{16}$"
}
}
}
{
"type": "object",
"properties": {
"premiaRewardsFlag": {
"description": "This is a flag that indicates if customer have premia rewards card",
"type": "boolean",
"example": true
},
"creditCardAccount": {
"type": "array",
"items": {
"$ref": "#/definitions/CreditCardAccount"
}
}
},
"required": [
"premiaRewardsFlag"
]
}
{
"type": "object",
"properties": {
"cardNumber": {
"description": "16 digit Card number of the credit card",
"type": "string",
"example": "1234567890123456",
"maxLength": 16,
"pattern": "^[0-9]{16}$"
},
"accountNumber": {
"description": "account number of the customer",
"type": "string",
"example": "1234567890123456"
},
"cardType": {
"description": "Card type Primary/Supplementary",
"type": "string",
"example": "PRIMARY",
"enum": [
"PRIMARY",
" SUPPLEMENTARY"
]
},
"cardStatus": {
"description": "card status",
"type": "string",
"example": "NORMAL"
},
"logoId": {
"description": "This is the logo id of the product",
"type": "string",
"example": "120"
},
"logoName": {
"description": "This is the logo name of the product",
"type": "string",
"example": "Delta Airlines"
},
"currencyCode": {
"description": "currency code of the account",
"type": "string",
"example": "MXN"
},
"currentBalanceAmount": {
"description": "current balance amount-balance of the card as of today",
"type": "number",
"format": "double",
"example": 2500.99,
"minimum": -9999999999999.99,
"maximum": 9999999999999.99
},
"availableCreditAmount": {
"description": "creditAvailableAmount of the credit card",
"type": "number",
"format": "double",
"example": 2000.99,
"minimum": -9999999999999.99,
"maximum": 9999999999999.99
},
"creditLimitAmount": {
"description": "credit limit amount of the credit card",
"type": "number",
"format": "double",
"example": 4500.99,
"minimum": -9999999999999.99,
"maximum": 9999999999999.99
},
"cashLimitAmount": {
"description": "cash credit limit of the credit card",
"type": "number",
"format": "double",
"example": 4000.99,
"minimum": -9999999999999.99,
"maximum": 9999999999999.99
},
"availableCashAmount": {
"description": "cash available amount of the account",
"type": "number",
"format": "double",
"example": 4000.99,
"minimum": -9999999999999.99,
"maximum": 9999999999999.99
},
"minimumPaymentDueAmount": {
"description": "minimum payment due amount",
"type": "number",
"format": "double",
"minimum": -9999999999999.99,
"example": 1500.99,
"maximum": 9999999999999.99
},
"lastStatementTotalBalanceAmount": {
"description": "Statement balance amount-balance as of last statement date",
"type": "number",
"format": "double",
"example": 3000.99,
"minimum": -9999999999999.99,
"maximum": 9999999999999.99
},
"totalPaymentAmount": {
"description": "minimumPaymentToAvoidInterest-to pay the complete pending amount to avoid interest",
"type": "number",
"format": "double",
"example": 5000.99,
"minimum": -9999999999999.99,
"maximum": 9999999999999.99
},
"paymentDueDate": {
"description": "payment due date",
"type": "string",
"format": "date",
"example": "2018-04-04"
},
"lastPaymentDate": {
"description": "Date on which the customer made the recent payment",
"type": "string",
"format": "date",
"example": "2018-05-03"
},
"lastStatementDate": {
"description": "Date on which the last statement was generated",
"type": "string",
"format": "date",
"example": "2018-05-05"
},
"cardValidFlag": {
"description": "Indicates if a card for which the details are requested is valid or not",
"type": "boolean",
"example": true
},
"cardInvalidDescription": {
"description": "Include a description when when the card is invalid or the above field cardValidFlag is false",
"type": "string",
"example": "Card not available"
}
},
"required": [
"cardNumber",
"currencyCode",
"availableCreditAmount",
"creditLimitAmount",
"cardValidFlag"
]
}
{
"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"
]
}