Jump to

• Request
• Response

Get Settlement Details By AccountId

get

/obcr-Settlement-services/settlementDetails/getSettlementDetails/{accountId}

This endpoint is used to get settlement details by Account Id.

Request

Supported Media Types

• application/json
• application/xml

Path Parameters

• accountId(required): string

Header Parameters

• appId(required): string
• branchCode(required): string
• contentType: string
• userId(required): string

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

Returns account related details when the collection status of account was set as settlement

Body ()

Root Schema : SettlementDetailsDto

Type: object

Settlement Details By Account Id

Show Source

• offerCounts: string
  Count of offers generated for the Account ID
• settlementInitationDetails: object SettlementInitDetailsDto
  Settlement Initiation Details
• settlementOfferDetails: array settlementOfferDetails
  Settlement Offer Details

{
    "description":"Settlement Details By Account Id",
    "type":"object",
    "properties":{
        "settlementInitationDetails":{
            "type":"object",
            "$ref":"#/definitions/SettlementInitDetailsDto",
            "description":"Settlement Initiation Details."
        },
        "settlementOfferDetails":{
            "type":"array",
            "description":"Settlement Offer Details ",
            "items":{
                "$ref":"#/definitions/SettlementOfferDto"
            }
        },
        "offerCounts":{
            "type":"string",
            "description":"Count of offers generated for the Account ID"
        }
    }
}

Nested Schema : SettlementInitDetailsDto

Type: object

Settlement Initiation Details

Show Source

• accountId: string
  Account ID
• interestAmt: number
  Interest Amount
• otherCharges: number
  Fees and Other Charges
• outstandingAmt: number
  Outstanding Amount
• principalAmt: number
  Principal Amount
• settlementInitDate: string
  Settlement Initiation Date

{
    "description":"Settlement Initiation Details",
    "type":"object",
    "properties":{
        "accountId":{
            "type":"string",
            "description":"Account ID"
        },
        "outstandingAmt":{
            "type":"number",
            "description":"Outstanding Amount"
        },
        "principalAmt":{
            "type":"number",
            "description":"Principal Amount"
        },
        "interestAmt":{
            "type":"number",
            "description":"Interest Amount"
        },
        "otherCharges":{
            "type":"number",
            "description":"Fees and Other Charges"
        },
        "settlementInitDate":{
            "type":"string",
            "description":"Settlement Initiation Date"
        }
    }
}

Nested Schema : settlementOfferDetails

Type: array

Settlement Offer Details

Show Source

• Array of: object SettlementOfferDto
  Settlement Offer Details

{
    "type":"array",
    "description":"Settlement Offer Details ",
    "items":{
        "$ref":"#/definitions/SettlementOfferDto"
    }
}

Nested Schema : SettlementOfferDto

Type: object

Settlement Offer Details

Show Source

• accountId: string
  Account ID
• expiryDate: string
  Date on which Offer will expire
• offerDate: string
  Date on which settlement Offer was made
• offerId: string
  Offer ID
• receivedAmt: number
  Received Amount
• settlementAmt: number
  Settlement Amount
• settlementDate: string
  Last Date for settlement
• settlementStatusCode: string
  Settlement Status Code
• settlementStatusDescription: string
  Settlement Status Description
• settlementTerm: number
  Settlement Term
• settlementType: string
  Settlement Type
• taskId: string
  Task Id

{
    "description":"Settlement Offer Details",
    "type":"object",
    "properties":{
        "offerId":{
            "type":"string",
            "description":"Offer ID"
        },
        "accountId":{
            "type":"string",
            "description":"Account ID"
        },
        "settlementAmt":{
            "type":"number",
            "description":"Settlement Amount"
        },
        "settlementTerm":{
            "type":"number",
            "description":"Settlement Term"
        },
        "settlementStatusCode":{
            "type":"string",
            "description":"Settlement Status Code"
        },
        "settlementStatusDescription":{
            "type":"string",
            "description":"Settlement Status Description"
        },
        "settlementType":{
            "type":"string",
            "description":"Settlement Type"
        },
        "offerDate":{
            "type":"string",
            "description":"Date on which settlement Offer was made"
        },
        "expiryDate":{
            "type":"string",
            "description":"Date on which Offer will expire"
        },
        "settlementDate":{
            "type":"string",
            "description":"Last Date for settlement"
        },
        "taskId":{
            "type":"string",
            "description":"Task Id"
        },
        "receivedAmt":{
            "type":"number",
            "description":"Received Amount"
        }
    }
}

400 Response

Malformed syntax.

401 Response

Request does not have sufficient credentials.

403 Response

Request is not authorized.

405 Response

Invalid input

500 Response

Internal error

Back to Top