production
development
https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext
Paths
/v1/cards/offers/availed/retrieve
post /v1/cards/offers/availed/retrieve
availed-card-offers
To retrieve the details of credit card offers availed by the customer
This API is used to retrieve the details of credit card offers availed by 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
sid
Required in header
string
SessionId sent by Consumer
availedCardOffersRequest
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/offers/availed/retrieve
Definitions
{
"type": "object",
"properties": {
"accountId": {
"description": "Unique identifier from the front end for the account",
"type": "string",
"example": "123456"
},
"customerId": {
"description": "Unique identifier of the customer",
"type": "string",
"example": "123456789012"
}
},
"required": [
"accountId"
]
}
{
"type": "object",
"properties": {
"creditCardOffer": {
"$ref": "#/definitions/CreditCardOffer"
}
}
}
{
"type": "object",
"properties": {
"cardLogoId": {
"description": "The id for the logo which is embossed on the card",
"type": "string",
"example": "530"
},
"cardNumber": {
"description": "Credit card number of the customer",
"type": "string",
"example": "1234567890123456"
},
"creditCardLoanOffer": {
"type": "array",
"items": {
"$ref": "#/definitions/CreditCardLoanOffer"
}
}
}
}
{
"type": "object",
"properties": {
"billedInstallmentPrincipalAmount": {
"description": "Amount billed from borrower as repayment to principal component in an installment paid to bank.",
"type": "number",
"format": "double",
"example": 50000.88
},
"billedInterestAmount": {
"description": "Billed Interest amount of credit card. The interest amount charged on credit card bill.",
"type": "number",
"format": "double",
"example": 55.88
},
"installmentCycle": {
"description": "Installment cycle is the interval of time from the end of one installment to the next installment",
"type": "string",
"example": "8"
},
"interestRate": {
"description": "Rate of Interest.Interest rate is the amount charged, expressed as a percentage of principal, by a lender to a borrower for the use of assets. Interest rates are typically noted on an annual basis, known as the annual percentage rate (APR).",
"type": "number",
"format": "double",
"example": 5.8
},
"lastInstallmentAmount": {
"description": "Amount of money borrower had paid as last installment",
"type": "number",
"format": "double",
"example": 70000.88
},
"lastInstallmentDate": {
"description": "Date when the last installment was paid",
"type": "string",
"format": "date",
"example": "2019-09-24"
},
"loanAmount": {
"description": "Loan amount on which offer has been given",
"type": "number",
"format": "double",
"example": 800000.88
},
"loanDate": {
"description": "Date of the loan",
"type": "string",
"format": "date",
"example": "2019-09-22"
},
"loanReferenceNumber": {
"description": "Unique reference number associated with the loan",
"type": "string",
"example": "2019-04-26-13.28.40.697897"
},
"loanSourceSystem": {
"description": "Loan Source",
"type": "string",
"example": "D"
},
"loanStatus": {
"description": "Loan status",
"type": "string",
"example": "8"
},
"loanTenure": {
"description": "Tenure of loan against credit card. It is considered in terms of number of months.",
"type": "integer",
"format": "int32",
"example": 6
},
"loanType": {
"description": "This field indicates type of Loan (Retail/Cash)",
"type": "string",
"example": "R"
},
"nextInstallmentInterestAmount": {
"description": "Amount of money that contributes to interest component in next installment.",
"type": "number",
"format": "double",
"example": 800.88
},
"nextInstallmentPrincipalAmount": {
"description": "Amount of money that contributes to principal component in next installment",
"type": "number",
"format": "double",
"example": 80000.88
},
"offerId": {
"description": "The attribute refers to the unique identification for an offer",
"type": "string",
"example": "4DCB1299"
},
"outstandingBalanceAmount": {
"description": "Amount of money owed which is yet to be paid.",
"type": "number",
"format": "double",
"example": 55000.88
},
"outstandingInterestAmount": {
"description": "Interest amount component that is yet to be paid by borrower to the bank.",
"type": "number",
"format": "double",
"example": 550.88
},
"outstandingTenureNumber": {
"description": "Outstanding number of months in which the remaining equal payment plan installments need to be paid",
"type": "integer",
"format": "int32",
"example": 4
},
"transactionDate": {
"description": "Refers to the system date when the actual transaction was executed for an account",
"type": "string",
"format": "date",
"example": "2019-09-23"
},
"transactionDescription": {
"description": "Refers to the detailed description of the transaction",
"type": "string",
"example": "DISPONIBLE BANAMEX"
}
}
}
{
"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"
]
}