REST API for Oracle Banking Virtual Account Management

Get all valid entity position enquiry

get

/service/entitypositionenquiry

This endpoints is be used to Get all valid entitypositionenquiry maintenance records.

Request

Supported Media Types

application/json
application/xml

Query Parameters

customerNumber: string

Real Customer Number
fromEntity(optional): string
includecloseandunauth(optional): boolean

includecloseandunauth need to be set to fetch summary record, defult value is false
limit(optional): integer

limit is maximum no of records to be fetched
offset(optional): integer

offset is starting no of records to be fetched
toEntity(optional): string
valueDate(optional): string

update date of the entities that need to be fetched

Header Parameters

sourceCode: string

Source from which request is initiated

Response

Supported Media Types

application/json
text/csv
application/xml

201 Response

Returns message of succes or failure

Headers

Location: string

Root Schema : VieTbInterEntityPositionsCollection

Type: object

Collection of interentitypositions.

Show Source

data(optional): array data
messages(optional): object ResponseDto
paging(optional): object PagingDto

{
    "description":"Collection of interentitypositions.",
    "type":"object",
    "properties":{
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/VieTbInterEntityPositionsDTO"
            }
        },
        "paging":{
            "$ref":"#/definitions/PagingDto"
        },
        "messages":{
            "$ref":"#/definitions/ResponseDto"
        }
    }
}

Nested Schema : data

Type: array

Show Source

Array of: object VieTbInterEntityPositionsDTO

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

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 : PagingDto

Type: object

Show Source

totalResults(optional): integer

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer"
        }
    }
}

Nested Schema : VieTbInterEntityPositionsDTO

Type: object

Match All

Show Source

object VieTbInterEntityPositionsDTO-allOf[0]

{
    "type":"object",
    "allOf":[
        {
            "type":"object",
            "properties":{
                "customerNumber":{
                    "type":"string",
                    "description":""
                },
                "fromAccount":{
                    "type":"string",
                    "description":""
                },
                "fromEntityId":{
                    "type":"string",
                    "description":""
                },
                "valueDate":{
                    "type":"string",
                    "description":""
                },
                "toAccount":{
                    "type":"string",
                    "description":""
                },
                "toEntityId":{
                    "type":"string",
                    "description":""
                },
                "id":{
                    "type":"string",
                    "description":""
                },
                "lastUpdateTimeStamp":{
                    "type":"string",
                    "description":""
                },
                "virAccountName":{
                    "type":"string",
                    "description":""
                },
                "realAccBranch":{
                    "type":"string",
                    "description":""
                },
                "currAmountDetails":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/CurrencyWiseEntityAggrDTO"
                    }
                }
            }
        }
    ]
}

Nested Schema : VieTbInterEntityPositionsDTO-allOf[0]

Type: object

Show Source

currAmountDetails(optional): array currAmountDetails
customerNumber(optional): string
fromAccount(optional): string
fromEntityId(optional): string
id(optional): string
lastUpdateTimeStamp(optional): string
realAccBranch(optional): string
toAccount(optional): string
toEntityId(optional): string
valueDate(optional): string
virAccountName(optional): string

{
    "type":"object",
    "properties":{
        "customerNumber":{
            "type":"string",
            "description":""
        },
        "fromAccount":{
            "type":"string",
            "description":""
        },
        "fromEntityId":{
            "type":"string",
            "description":""
        },
        "valueDate":{
            "type":"string",
            "description":""
        },
        "toAccount":{
            "type":"string",
            "description":""
        },
        "toEntityId":{
            "type":"string",
            "description":""
        },
        "id":{
            "type":"string",
            "description":""
        },
        "lastUpdateTimeStamp":{
            "type":"string",
            "description":""
        },
        "virAccountName":{
            "type":"string",
            "description":""
        },
        "realAccBranch":{
            "type":"string",
            "description":""
        },
        "currAmountDetails":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/CurrencyWiseEntityAggrDTO"
            }
        }
    }
}

Nested Schema : currAmountDetails

Type: array

Show Source

Array of: object CurrencyWiseEntityAggrDTO

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

Nested Schema : CurrencyWiseEntityAggrDTO

Type: object

Match All

Show Source

object CurrencyWiseEntityAggrDTO-allOf[0]

{
    "type":"object",
    "allOf":[
        {
            "type":"object",
            "properties":{
                "currency":{
                    "type":"string",
                    "description":""
                },
                "amount":{
                    "type":"number",
                    "description":""
                }
            }
        }
    ]
}

Nested Schema : CurrencyWiseEntityAggrDTO-allOf[0]

Type: object

Show Source

amount(optional): number
currency(optional): string

{
    "type":"object",
    "properties":{
        "currency":{
            "type":"string",
            "description":""
        },
        "amount":{
            "type":"number",
            "description":""
        }
    }
}

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.

405 Response

Invalid input

500 Response

Internal error