REST API for Oracle Banking Collections

Retrieve the 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: integer

Limit is maximum number of records to be fetched.
offset: integer

Offset is starting number of records to be fetched.

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.

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

Root Schema : DmAccountIdsAndFilterCollection

Type: object

Collection of Account IDs and Account Filter.

Show Source

dmAccountFilter: object DmAccountFilterDTO

Filters for account
dmAccountIdsList: array dmAccountIdsList

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

Nested Schema : DmAccountFilterDTO

Type: object

Filters for account

Show Source

daysPastDueMax: number

Days Past Due maximum
daysPastDueMin: number

Days Past Due minimum
overDueAmountMax: number

Over Due Amount maximum
overDueAmountMin: number

Over Due Amount minimum

{
    "description":"Filters for account",
    "type":"object",
    "properties":{
        "daysPastDueMin":{
            "description":"Days Past Due minimum",
            "type":"number"
        },
        "daysPastDueMax":{
            "description":"Days Past Due maximum",
            "type":"number"
        },
        "overDueAmountMin":{
            "description":"Over Due Amount minimum",
            "type":"number"
        },
        "overDueAmountMax":{
            "description":"Over Due Amount maximum",
            "type":"number"
        }
    }
}

Nested Schema : dmAccountIdsList

Type: array

Show Source

Array of: string

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

Response

Supported Media Types

application/json
application/xml

200 Response

Returns list of limited account party details.

Root Schema : DmAccountPartySummaryDTOCollection

Type: object

Collection of DmAccountPartySummaryDTO.

Show Source

dmAccountPartySummaryDTOList: array dmAccountPartySummaryDTOList

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

Nested Schema : dmAccountPartySummaryDTOList

Type: array

Show Source

Array of: object DmAccountPartySummaryDTO

DmAccountPartySummaryDTO model

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

Nested Schema : DmAccountPartySummaryDTO

Type: object

DmAccountPartySummaryDTO model

Show Source

accountId: string

Account Id
accountNbr: string

Account Number
acctCurrCd: string

acctCurrCd of the DmAccount
customerName: string

customerName of the Party
daysPastDue: number

daysPastDue of the DmAccount
overdueAmt: number

overdueAmt of the DmAccount
partyId: string

PartyId
prdProcessrCd: string

prdProcessrCd of the DmAccount
productSubTypCd: string

productSubTypCd of the DmAccount
productTypCd: string

productTypCd of the DmAccount

{
    "description":"DmAccountPartySummaryDTO model",
    "type":"object",
    "properties":{
        "accountId":{
            "description":"Account Id",
            "type":"string"
        },
        "accountNbr":{
            "description":"Account Number",
            "type":"string"
        },
        "productTypCd":{
            "description":"productTypCd of the DmAccount",
            "type":"string"
        },
        "productSubTypCd":{
            "description":"productSubTypCd of the DmAccount",
            "type":"string"
        },
        "overdueAmt":{
            "description":"overdueAmt of the DmAccount",
            "type":"number"
        },
        "acctCurrCd":{
            "description":"acctCurrCd of the DmAccount",
            "type":"string"
        },
        "daysPastDue":{
            "description":"daysPastDue of the DmAccount",
            "type":"number"
        },
        "prdProcessrCd":{
            "description":"prdProcessrCd of the DmAccount",
            "type":"string"
        },
        "partyId":{
            "description":"PartyId",
            "type":"string"
        },
        "customerName":{
            "description":"customerName of the Party",
            "type":"string"
        }
    }
}

201 Response

Returns message of success or failure.

Headers

Location: string

Limited Account Party Details.

Root Schema : ResponseDtoWrapper

Type: object

Response Data Transfer object

Show Source

data: object ResponseResourceSupport
messages: object ResponseDto

Response Data Transfer object

{
    "type":"object",
    "description":"Response Data Transfer object",
    "properties":{
        "messages":{
            "description":"Messages",
            "$ref":"#/definitions/ResponseDto"
        },
        "data":{
            "description":"Data",
            "$ref":"#/definitions/ResponseResourceSupport"
        }
    }
}

Nested Schema : ResponseResourceSupport

Type: object

Nested Schema : ResponseDto

Type: object

Response Data Transfer object

Show Source

codes: array codes

Codes
id: string

ID
requestId: string

Request ID
status: string

Status

{
    "description":"Response Data Transfer object",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"ID"
        },
        "status":{
            "type":"string",
            "description":"Status"
        },
        "codes":{
            "type":"array",
            "description":"Codes",
            "items":{
                "$ref":"#/definitions/ResponseCode"
            }
        },
        "requestId":{
            "type":"string",
            "description":"Request ID"
        }
    }
}

Nested Schema : codes

Type: array

Codes

Show Source

Array of: object ResponseCode

Response code

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

Nested Schema : ResponseCode

Type: object

Response code

Show Source

arg: string

Argument
args: array args

Arguments
Code: string

Code
Desc: string

Description
Language: string

Language
Type: string

Type

{
    "type":"object",
    "description":"Response code",
    "properties":{
        "Code":{
            "type":"string",
            "description":"Code"
        },
        "Desc":{
            "type":"string",
            "description":"Description"
        },
        "Type":{
            "type":"string",
            "description":"Type"
        },
        "Language":{
            "type":"string",
            "description":"Language"
        },
        "args":{
            "type":"array",
            "description":"Arguments",
            "items":{
                "type":"object"
            }
        },
        "arg":{
            "type":"string",
            "description":"Argument"
        }
    }
}

Nested Schema : args

Type: array

Arguments

Show Source

Array of: object items

{
    "type":"array",
    "description":"Arguments",
    "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.