Jump to

• Request
• Response

Retrieve List of Limited Account Party Details by Account ID's and Filter Collection

post

/dmaccount-service/accounts/limitedAcctPartyDetails

This endpoint is used to retrieve the list of limited Account Party details by Account ID's and Filter Collection.

Request

Supported Media Types

• application/json
• application/xml

Query Parameters

• limit(optional): integer
  Limit is maximum number of records to be fetched.
• offset(optional): integer
  Offset is starting number of records 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.

Body ()

Request Body that contains data required for fetching account party details.

Root Schema : DmAccountIdsAndFilterCollection

Type: object

Collection of Account ID filter

Show Source

• dmAccountFilter(optional): object DmAccountFilterDTO
• dmAccountIdsList(optional): array dmAccountIdsList
  Account IDs List

{
    "description":"Collection of Account ID filter",
    "type":"object",
    "properties":{
        "dmAccountIdsList":{
            "description":"Account IDs List",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "dmAccountFilter":{
            "description":"Account Filter",
            "$ref":"#/definitions/DmAccountFilterDTO"
        }
    }
}

Nested Schema : DmAccountFilterDTO

Type: object

Show Source

• daysPastDueMax(optional): number
  Days Past Due Maximum
• daysPastDueMin(optional): number
  Days Past Due Minimum
• overDueAmountMax(optional): number
  Overdue Amount Maximum
• overDueAmountMin(optional): number
  Overdue Amount Minimum

{
    "type":"object",
    "properties":{
        "daysPastDueMin":{
            "type":"number",
            "description":"Days Past Due Minimum"
        },
        "daysPastDueMax":{
            "type":"number",
            "description":"Days Past Due Maximum"
        },
        "overDueAmountMin":{
            "type":"number",
            "description":"Overdue Amount Minimum"
        },
        "overDueAmountMax":{
            "type":"number",
            "description":"Overdue Amount Maximum"
        }
    }
}

Nested Schema : dmAccountIdsList

Type: array

Account IDs List

Show Source

• Array of: string

{
    "description":"Account IDs List",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

Returns list of limited account party details.

Body ()

Root Schema : DmAccountPartySummaryDTOCollection

Type: object

Collection of Account Party Summary

Show Source

• dmAccountPartySummaryDTOList(optional): array dmAccountPartySummaryDTOList
  Account Party Summary List

{
    "description":"Collection of Account Party Summary",
    "type":"object",
    "properties":{
        "dmAccountPartySummaryDTOList":{
            "description":"Account Party Summary List",
            "type":"array",
            "items":{
                "$ref":"#/definitions/DmAccountPartySummaryDTO"
            }
        }
    }
}

Nested Schema : dmAccountPartySummaryDTOList

Type: array

Account Party Summary List

Show Source

• Array of: object DmAccountPartySummaryDTO
  Account party summary data transfer object

{
    "description":"Account Party Summary List",
    "type":"array",
    "items":{
        "$ref":"#/definitions/DmAccountPartySummaryDTO"
    }
}

Nested Schema : DmAccountPartySummaryDTO

Type: object

Account party summary data transfer object

Show Source

• accountId(optional): string
  Account ID
• accountNbr(optional): string
  Account Number
• acctCurrCd(optional): string
  Account currency code of the DmAccount
• customerName(optional): string
  Customer Name
• daysPastDue(optional): number
  Days Past Due of the DmAccount
• overdueAmt(optional): number
  overdue amount of the DmAccount
• partyId(optional): string
  Party ID
• prdProcessrCd(optional): string
  Product Processor Code of the DmAccount
• productSubTypCd(optional): string
  product SubType Code of the DmAccount
• productTypCd(optional): string
  product Type Code of the DmAccount

{
    "type":"object",
    "description":"Account party summary data transfer object",
    "properties":{
        "accountId":{
            "description":"Account ID",
            "type":"string"
        },
        "accountNbr":{
            "description":"Account Number",
            "type":"string"
        },
        "productTypCd":{
            "description":"product Type Code of the DmAccount",
            "type":"string"
        },
        "productSubTypCd":{
            "description":"product SubType Code of the DmAccount",
            "type":"string"
        },
        "overdueAmt":{
            "description":"overdue amount of the DmAccount",
            "type":"number"
        },
        "acctCurrCd":{
            "description":"Account currency code of the DmAccount",
            "type":"string"
        },
        "daysPastDue":{
            "description":"Days Past Due of the DmAccount",
            "type":"number"
        },
        "prdProcessrCd":{
            "description":"Product Processor Code of the DmAccount",
            "type":"string"
        },
        "partyId":{
            "description":"Party ID",
            "type":"string"
        },
        "customerName":{
            "description":"Customer Name",
            "type":"string"
        }
    }
}

201 Response

Returns message of success or failure.

Headers

• Location: string
  Limited Account Party Details.

Body ()

Root Schema : ResponseDtoWrapper

Type: object

Show Source

• data(optional): object ResponseResourceSupport
• messages(optional): object ResponseDto

{
    "type":"object",
    "properties":{
        "messages":{
            "$ref":"#/definitions/ResponseDto"
        },
        "data":{
            "$ref":"#/definitions/ResponseResourceSupport"
        }
    }
}

Nested Schema : ResponseResourceSupport

Type: object

Nested Schema : ResponseDto

Type: object

Show Source

• codes(optional): array codes
• id(optional): string
• requestId(optional): string
• status(optional): string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "status":{
            "type":"string"
        },
        "codes":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ResponseCode"
            }
        },
        "requestId":{
            "type":"string"
        }
    }
}

Nested Schema : codes

Type: array

Show Source

• Array of: object ResponseCode

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

Nested Schema : ResponseCode

Type: object

Show Source

• arg(optional): string
• args(optional): array args
• Code(optional): string
• Desc(optional): string
• Language(optional): string
• Type(optional): string

{
    "type":"object",
    "properties":{
        "Code":{
            "type":"string"
        },
        "Desc":{
            "type":"string"
        },
        "Type":{
            "type":"string"
        },
        "Language":{
            "type":"string"
        },
        "args":{
            "type":"array",
            "items":{
                "type":"object"
            }
        },
        "arg":{
            "type":"string"
        }
    }
}

Nested Schema : args

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : items

Type: object

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