production
development
https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext
Paths
/v1/cards/credit-cards/offers/detail/retrieve
post /v1/cards/credit-cards/offers/detail/retrieve
retrieve-credit-card-offers-info
To retrieve the available offers on the credit card for the customer.
This API is used to retrieve the available offers on the credit card 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
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
retrieveCreditCardOffersRequest
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/offers/detail/retrieve
Definitions
{
"type": "object",
"properties": {
"accountId": {
"description": "Unique ID used by front end to identify the account",
"type": "string",
"example": "123456"
}
}
}
{
"type": "object",
"properties": {
"offers": {
"type": "array",
"items": {
"$ref": "#/definitions/Offer"
}
}
}
}
{
"type": "object",
"properties": {
"offerId": {
"description": "This attribute holds the unique identifier of the offer",
"type": "string",
"example": "123456"
},
"accountId": {
"description": "Unique ID used by front end to identify the account",
"type": "string",
"example": "123456"
},
"transactionDescription": {
"description": "Description of the transaction",
"type": "string",
"example": "Installment Payment"
},
"transactionDate": {
"description": "Description of the transaction",
"type": "string",
"format": "date",
"example": "2020-03-22"
},
"authorizationCode": {
"description": "Authorization codes are used for any transaction or entry that has restrictions on which users are entitled to access",
"type": "string",
"example": "123456"
},
"cardOfferType": {
"description": "The attribute refers to the type of card offer",
"type": "string",
"example": "BalconOffer"
},
"interestRate": {
"description": "Rate of interest charged on the payment.",
"type": "number",
"format": "double",
"example": 15.55
},
"merchantName": {
"description": "It is the name of the merchant.",
"type": "string",
"example": "SmartFit"
},
"expiryDate": {
"description": "Offer expiry date.",
"type": "string",
"format": "date",
"example": "2020-05-12"
},
"minimumLoanAmount": {
"description": "Minimum loan amount.",
"type": "number",
"format": "double",
"example": 5500.55
},
"maximumLoanAmount": {
"description": "Maximum loan amount.",
"type": "number",
"format": "double",
"example": 6500.55
},
"annualPercentageRate": {
"description": "The offered Annual Percentage Rate.",
"type": "number",
"format": "double",
"example": 15.55
},
"creditCardLoanOffers": {
"type": "array",
"items": {
"$ref": "#/definitions/CreditCardLoanOffer"
}
}
},
"required": [
"offerId"
]
}
{
"type": "object",
"properties": {
"loanTenure": {
"description": "Tenure of loan against credit card. It is considered in terms of number of months.",
"type": "integer",
"example": 6
}
}
}
{
"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"
]
}