Jump to

• Request
• Response

Get settlement related details.

get

/obcr-correspondence-services/commdetails/settlementCommDetails

This endpoint is used to get settlement related details.

Request

Supported Media Types

• application/json
• application/xml

Query Parameters

• accountId(required): string
  Account Id for which settlement details is to be fetched
• settlementOfferDate(required): string
  Settlement Offer Date

Header Parameters

• appId(required): string
  The application ID of host service.
• branchCode(required): string
  The branch code of requesting branch.
• contentType: string
  The content type of request or response body.
• userId(required): string
  The user ID of requesting user.

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

Returns message of success or failure

Body ()

Root Schema : SettlementCommDetailsDto

Type: object

Show Source

• isOffereGenerated: boolean
  Flag value to determine if settlement related communication is done after Offer initiation

{
    "type":"object",
    "properties":{
        "isOffereGenerated":{
            "type":"boolean",
            "description":"Flag value to determine if settlement related communication is done after Offer initiation"
        }
    }
}

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