Jump to

• Request
• Response

Retrieve Account Details for Correspondence Batch

get

/dmaccount-service/accounts/getOBRSDetails/{accountId}

This endpoints will be used to retrieve account data for correspondence batch.

Request

Supported Media Types

• application/json
• application/xml

Path Parameters

• accountId: string
  Account ID for which details to be fetched.

Header Parameters

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

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

returns list of in collection account ID's.

Body ()

Root Schema : DmAccountPartyDetailsDTO

Type: object

DmAccountPartySummaryDTO model

Show Source

• accountId(optional): string
  Account Id
• accountNbr(optional): string
  Account Number
• accountStatus(optional): string
  Account Status
• bankName(optional): string
  Bank Name
• dmPartyDetails(optional): array dmPartyDetails
• headOfficeBranch(optional): string
  Head Office Branch
• headOfficeBranchAdd(optional): string
  Head Office Branch Address
• headOfficeBranchContactNo(optional): string
  Head Office Branch Contact Number
• homeBranchCode(optional): string
  Home Branch Code
• homeBranchCodeDes(optional): string
  Home Branch Code Description

{
    "description":"DmAccountPartySummaryDTO model",
    "type":"object",
    "properties":{
        "accountId":{
            "description":"Account Id",
            "type":"string"
        },
        "accountNbr":{
            "description":"Account Number",
            "type":"string"
        },
        "accountStatus":{
            "description":"Account Status",
            "type":"string"
        },
        "homeBranchCode":{
            "description":"Home Branch Code",
            "type":"string"
        },
        "homeBranchCodeDes":{
            "description":"Home Branch Code Description",
            "type":"string"
        },
        "bankName":{
            "description":"Bank Name",
            "type":"string"
        },
        "headOfficeBranch":{
            "description":"Head Office Branch",
            "type":"string"
        },
        "headOfficeBranchAdd":{
            "description":"Head Office Branch Address",
            "type":"string"
        },
        "headOfficeBranchContactNo":{
            "description":"Head Office Branch Contact Number",
            "type":"string"
        },
        "dmPartyDetails":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/DmPartyDetails"
            }
        }
    }
}

Nested Schema : dmPartyDetails

Type: array

Show Source

• Array of: object DmPartyDetails
  DmAccountPartySummaryDTO model

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/DmPartyDetails"
    }
}

Nested Schema : DmPartyDetails

Type: object

DmAccountPartySummaryDTO model

Show Source

• customerAddress(optional): string
  customerAddress of the Party
• customerName(optional): string
  customerName of the Party
• partyId(optional): string
  PartyId

{
    "description":"DmAccountPartySummaryDTO model",
    "type":"object",
    "properties":{
        "partyId":{
            "description":"PartyId",
            "type":"string"
        },
        "customerName":{
            "description":"customerName of the Party",
            "type":"string"
        },
        "customerAddress":{
            "description":"customerAddress of the Party",
            "type":"string"
        }
    }
}

400 Response

Malformed syntax.

401 Response

Request does not have sufficient credentials.

403 Response

Request is not authorized.

500 Response

Internal error.

Back to Top