CRDS-CCC-V-CreditCardInstallmentsView

CRDS-CCC-V-CreditCardInstallmentsView 1.0.0

0
No votes yet

This microservice is used to manage the functionalities related to the offers for the credit cards. This is the service at the Edge layer.

production
development
https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext

Paths

/v1/cards/credit-cards/installments/deferred-amount/detail/retrieve

post /v1/cards/credit-cards/installments/deferred-amount/detail/retrieve
retrieve-deferred-balance-info

To retrieve the available deferred amount of the credit card for the installment offers.

This API is used to retrieve the available deferred amount of the credit card for the installment offers.

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

retrieveDeferredBalanceRequest
Optional in body
object
RetrieveDeferredBalanceRequest
200

Successful operation.

RetrieveDeferredBalanceResponse
400
TypeCodeDetails
errorinvalidRequestMissing or invalid Parameters
ErrorResponse
401
TypeCodeDetails
errorunAuthorizedAuthorization credentials are missing or invalid
ErrorResponse
403
TypeCodeDetailsMore Info
erroraccessNotConfiguredThe request operation is not configured to access this resourceChannel/Country/Business provided in the request is not supported currently
ErrorResponse
404
TypeCodeDetailsMore Info
errorresourceNotFoundThe requested resource was not foundEmpty resource/resource not found
ErrorResponse
422
TypeCodeDetails
errorbusinessValidationFailedBusiness validation error occured on one or more parameters
ErrorResponse
500
TypeCodeDetails
fatalserverUnavailableThe request failed due to an internal error/server unavailability
ErrorResponse
Example Request
Example Response
POST https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext/api/v1/cards/credit-cards/installments/deferred-amount/detail/retrieve

/v1/cards/credit-cards/installments/detail/retrieve

post /v1/cards/credit-cards/installments/detail/retrieve
retrieve-installment-options-info

To retrieve the installment offers available for the payment of deferred balance of the credit card.

This API is used to retrieve the installment offers available for the payment of deferred balance of the credit 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
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

retrieveInstallmentOptionsRequest
Optional in body
object
RetrieveInstallmentOptionsRequest
200

Successful operation.

RetrieveInstallmentOptionsResponse
400
TypeCodeDetails
errorinvalidRequestMissing or invalid Parameters
ErrorResponse
401
TypeCodeDetails
errorunAuthorizedAuthorization credentials are missing or invalid
ErrorResponse
403
TypeCodeDetailsMore Info
erroraccessNotConfiguredThe request operation is not configured to access this resourceChannel/Country/Business provided in the request is not supported currently
ErrorResponse
404
TypeCodeDetailsMore Info
errorresourceNotFoundThe requested resource was not foundEmpty resource/resource not found
ErrorResponse
422
TypeCodeDetails
errorbusinessValidationFailedBusiness validation error occured on one or more parameters
ErrorResponse
500
TypeCodeDetails
fatalserverUnavailableThe request failed due to an internal error/server unavailability
ErrorResponse
Example Request
Example Response
POST https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext/api/v1/cards/credit-cards/installments/detail/retrieve

Definitions 

{
    "type": "object",
    "properties": {
        "accountId": {
            "description": "Unique ID used by front end to identify the account",
            "type": "string",
            "example": "123456"
        }
    },
    "required": [
        "accountId"
    ]
}
              
{
    "type": "object",
    "properties": {
        "availableDeferredAmount": {
            "description": "Refers to the available deferred amount",
            "type": "number",
            "format": "double",
            "example": 9500.55
        }
    },
    "required": [
        "availableDeferredAmount"
    ]
}
              
{
    "type": "object",
    "properties": {
        "accountId": {
            "description": "Unique ID used by front end to identify the account",
            "type": "string",
            "example": "123456"
        },
        "offerId": {
            "description": "This attribute holds the unique identifier of the offer",
            "type": "string",
            "example": "123456"
        },
        "totalInstallmentPaymentAmount": {
            "description": "The total amount selected to be paid in installments",
            "type": "number",
            "format": "double",
            "example": 9500.55
        }
    },
    "required": [
        "accountId",
        "offerId",
        "totalInstallmentPaymentAmount"
    ]
}
              
{
    "type": "object",
    "properties": {
        "creditCardLoanOffer": {
            "type": "array",
            "items": {
                "$ref": "#/definitions/CreditCardLoanOffer"
            }
        }
    }
}
              
{
    "type": "object",
    "properties": {
        "loanTenure": {
            "description": "Tenure of loan against credit card. It is considered in terms of number of months.",
            "type": "integer",
            "example": "6"
        },
        "installmentPrincipalAmount": {
            "description": "Installment amount to be payed by customer. This is without the interest amount.",
            "type": "number",
            "format": "double",
            "example": 1583.42
        },
        "interestRate": {
            "description": "Special rate of interest that has been offered for the loan.",
            "type": "number",
            "format": "double",
            "example": 15.55
        },
        "installmentInterestAmount": {
            "description": "Interest component in the installment.",
            "type": "number",
            "format": "double",
            "example": 237.51
        },
        "installmentAmount": {
            "description": "Total Installment amount to be payed by customer  including the interest amount.",
            "type": "number",
            "format": "double",
            "example": 1820.93
        }
    },
    "required": [
        "loanTenure",
        "installmentPrincipalAmount",
        "interestRate",
        "installmentInterestAmount",
        "installmentAmount"
    ]
}
              
{
    "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"
    ]
}