Rest API for Oracle Banking Cash Management

Fetch the relationship master for given associated party

get

/service/v1/relationshipmaster/associatedPartiesList

This endpoint is used to fetch the relationship master for given associated party.

Request

Supported Media Types

application/json
application/xml

Query Parameters

associatedPartyRole(optional): string

Can be either B/S. B-Buyer, S- Supplier.
associatedPartyType(optional): string

Can be either C/CP. C- Corporate, CP-Counterparty.
authStatus(optional): string

Corporate can check list of authorized, non-authorized counterparty. If value of this field is blank than all parties would be returned.
isChildDataReq(optional): string

flag for child data required
name(optional): string

Party Name whose associated parties have to be found.
partyId(optional): string

The party whose associated parties have to be identified. Either partyId or name is required. If party id and name both are sent, then system will use party id.
relationshipCode(optional): string

Relationship code for filter

Header Parameters

appId: string
branchCode: string

branchCode
userId: string

userId

Response

Supported Media Types

application/json
application/xml

201 Response

Returns message of succes or failure

Headers

Location: string

URL of newly created relationshipmaster

Root Schema : AssociatedPartiesResponseList

Type: object

Response of Associated Parties Respose

Show Source

corporates(optional): object corporates
counterparties(optional): object counterparties

Counterparties
partyId(optional): string

Party Id

{
    "description":"Response of Associated Parties Respose",
    "type":"object",
    "properties":{
        "partyId":{
            "type":"string",
            "description":"Party Id"
        },
        "counterparties":{
            "type":"object",
            "description":"Counterparties",
            "properties":{
                "buyer":{
                    "type":"array",
                    "description":"Contains all associated buyer Counterparty details of party Id",
                    "items":{
                        "$ref":"#/definitions/AssociatedParties"
                    }
                },
                "seller":{
                    "type":"array",
                    "description":"Contains all associated seller Counterparty details of party Id",
                    "items":{
                        "$ref":"#/definitions/AssociatedParties"
                    }
                }
            }
        },
        "corporates":{
            "type":"object",
            "properties":{
                "buyer":{
                    "type":"array",
                    "description":"Contains all associated corporate details of Buyer party Id",
                    "items":{
                        "$ref":"#/definitions/AssociatedParties"
                    }
                },
                "seller":{
                    "type":"array",
                    "description":"Contains all associated corporate details of Seller party Id",
                    "items":{
                        "$ref":"#/definitions/AssociatedParties"
                    }
                }
            }
        }
    }
}

Nested Schema : corporates

Type: object

Show Source

buyer(optional): array buyer

Contains all associated corporate details of Buyer party Id
seller(optional): array seller

Contains all associated corporate details of Seller party Id

{
    "type":"object",
    "properties":{
        "buyer":{
            "type":"array",
            "description":"Contains all associated corporate details of Buyer party Id",
            "items":{
                "$ref":"#/definitions/AssociatedParties"
            }
        },
        "seller":{
            "type":"array",
            "description":"Contains all associated corporate details of Seller party Id",
            "items":{
                "$ref":"#/definitions/AssociatedParties"
            }
        }
    }
}

Nested Schema : counterparties

Type: object

Counterparties

Show Source

buyer(optional): array buyer

Contains all associated buyer Counterparty details of party Id
seller(optional): array seller

Contains all associated seller Counterparty details of party Id

{
    "type":"object",
    "description":"Counterparties",
    "properties":{
        "buyer":{
            "type":"array",
            "description":"Contains all associated buyer Counterparty details of party Id",
            "items":{
                "$ref":"#/definitions/AssociatedParties"
            }
        },
        "seller":{
            "type":"array",
            "description":"Contains all associated seller Counterparty details of party Id",
            "items":{
                "$ref":"#/definitions/AssociatedParties"
            }
        }
    }
}

Nested Schema : buyer

Type: array

Contains all associated corporate details of Buyer party Id

Show Source

Array of: object AssociatedParties

Response of Associated Parties Respose

{
    "type":"array",
    "description":"Contains all associated corporate details of Buyer party Id",
    "items":{
        "$ref":"#/definitions/AssociatedParties"
    }
}

Nested Schema : seller

Type: array

Contains all associated corporate details of Seller party Id

Show Source

Array of: object AssociatedParties

Response of Associated Parties Respose

{
    "type":"array",
    "description":"Contains all associated corporate details of Seller party Id",
    "items":{
        "$ref":"#/definitions/AssociatedParties"
    }
}

Nested Schema : AssociatedParties

Type: object

Response of Associated Parties Respose

Show Source

data(optional): array data

Contains all associated buyer Counterparty details of party Id
paging(optional): object PagingDto

Paging Dto

{
    "description":"Response of Associated Parties Respose",
    "type":"object",
    "properties":{
        "data":{
            "type":"array",
            "description":"Contains all associated buyer Counterparty details of party Id",
            "items":{
                "$ref":"#/definitions/AssociatedPartyData"
            }
        },
        "paging":{
            "$ref":"#/definitions/PagingDto"
        }
    }
}

Nested Schema : data

Type: array

Contains all associated buyer Counterparty details of party Id

Show Source

Array of: object AssociatedPartyData

Response of Associated Parties Response

{
    "type":"array",
    "description":"Contains all associated buyer Counterparty details of party Id",
    "items":{
        "$ref":"#/definitions/AssociatedPartyData"
    }
}

Nested Schema : PagingDto

Type: object

Paging Dto

Show Source

totalResults(optional): integer

Total Results

{
    "type":"object",
    "description":"Paging Dto",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"Total Results"
        }
    }
}

Nested Schema : AssociatedPartyData

Type: object

Response of Associated Parties Response

Show Source

customerId(optional): string

Associated Counter/Corporate Id
customerName(optional): string

Name of associated Counter/Corporate Id

{
    "description":"Response of Associated Parties Response",
    "type":"object",
    "properties":{
        "customerId":{
            "type":"string",
            "description":"Associated Counter/Corporate Id"
        },
        "customerName":{
            "type":"string",
            "description":"Name of associated Counter/Corporate Id"
        }
    }
}

Nested Schema : buyer

Type: array

Contains all associated buyer Counterparty details of party Id

Show Source

Array of: object AssociatedParties

Response of Associated Parties Respose

{
    "type":"array",
    "description":"Contains all associated buyer Counterparty details of party Id",
    "items":{
        "$ref":"#/definitions/AssociatedParties"
    }
}

Nested Schema : seller

Type: array

Contains all associated seller Counterparty details of party Id

Show Source

Array of: object AssociatedParties

Response of Associated Parties Respose

{
    "type":"array",
    "description":"Contains all associated seller Counterparty details of party Id",
    "items":{
        "$ref":"#/definitions/AssociatedParties"
    }
}

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