--- swagger: "2.0" info: title: CRDS-CSO-V-CreditCardOffers description: This Microservice is used to manage the services related to the credit card offers for the customer. This service is at the Edge layer of the architecture. version: 1.0.0 x-ibm-name: crds-cso-v-creditcardoffers host: 127.0.0.1 schemes: - https basePath: /api produces: - application/json paths: /v1/cards/offers/availed/retrieve: post: tags: - availed-card-offers operationId: availed-card-offers summary: To retrieve the details of credit card offers availed by the customer description: This API is used to retrieve the details of credit card offers availed by the customer consumes: - application/json produces: - application/json parameters: - name: client_id in: header required: true type: string description: Client ID generated during application registration - name: Authorization in: header required: true type: string description: The Authorization Token received during login - name: Accept in: header required: true type: string description: Content-Types that are acceptable for the response - name: uuid in: header required: true type: string description: 128 bit UUID that you generate for every request - name: Accept-Language in: header required: false type: string description: List of acceptable human languages for response - name: Content-Type in: header required: true type: string description: Content-Types that are sent in the request - name: ChannelId in: header required: true type: string description: Channel where request originated - name: sid in: header required: true type: string description: SessionId sent by Consumer - name: availedCardOffersRequest in: body schema: $ref: '#/definitions/AvailedCardOffersRequest' responses: 200: description: Successful operation. schema: $ref: '#/definitions/AvailedCardOffersResponse' 400: description:
TypeCodeDetails
errorinvalidRequestMissing or invalid Parameters
schema: $ref: '#/definitions/ErrorResponse' 401: description:
TypeCodeDetails
errorunAuthorizedAuthorization credentials are missing or invalid
schema: $ref: '#/definitions/ErrorResponse' 403: description:
TypeCodeDetailsMore Info
erroraccessNotConfiguredThe request operation is not configured to access this resourceChannel/Country/Business provided in the request is not supported currently
schema: $ref: '#/definitions/ErrorResponse' 404: description:
TypeCodeDetailsMore Info
errorresourceNotFoundThe requested resource was not foundEmpty resource/resource not found
schema: $ref: '#/definitions/ErrorResponse' 422: description:
TypeCodeDetails
errorbusinessValidationFailedBusiness validation error occured on one or more parameters
schema: $ref: '#/definitions/ErrorResponse' 500: description:
TypeCodeDetails
fatalserverUnavailableThe request failed due to an internal error/server unavailability
schema: $ref: '#/definitions/ErrorResponse' definitions: AvailedCardOffersRequest: 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 AvailedCardOffersResponse: type: object properties: creditCardOffer: $ref: '#/definitions/CreditCardOffer' 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' 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.880000 billedInterestAmount: description: Billed Interest amount of credit card. The interest amount charged on credit card bill. type: number format: double example: 55.880000 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.800000 lastInstallmentAmount: description: Amount of money borrower had paid as last installment type: number format: double example: 70000.880000 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.880000 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.880000 nextInstallmentPrincipalAmount: description: Amount of money that contributes to principal component in next installment type: number format: double example: 80000.880000 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.880000 outstandingInterestAmount: description: Interest amount component that is yet to be paid by borrower to the bank. type: number format: double example: 550.880000 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 ErrorResponse: 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 x-ibm-configuration: enforced: true testable: true phase: realized securityDefinitions: OAuth2 Application Flow: type: oauth2 description: "" flow: application scopes: /api/v1: "" tokenUrl: https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext/api/v1/oauth/token Client ID: type: apiKey description: "" in: header name: X-IBM-Client-Id security: - OAuth2 Application Flow: - /api/v1 Client ID: [] x-ibm-endpoints: - endpointUrl: https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext type: - production - development ...