REST API for Oracle Banking Virtual Account Management Cloud Service

Get all valid charge definition

get

/service/chargedefinition

This endpoint is used to get all valid charge definitions maintained.

Request

Supported Media Types

application/json
application/xml

Query Parameters

applicationCode(required): string

Application for which the data is processed -VAMCHG/LMCHG
authStat: string
chargeCategory: string
chargeCode: string
chargeCodeDesc: string
includecloseandunauth: boolean

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

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

offset is starting no of records to be fetched
recordStat: string

Header Parameters

sourceCode(required): 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 : VlcTmChargesServiceCollection

Type: object

Collection of charges.

Show Source

data: array data
paging: object PagingDto

{
    "description":"Collection of charges.",
    "type":"object",
    "properties":{
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/VlcTmChargesServiceDTO"
            }
        },
        "paging":{
            "$ref":"#/definitions/PagingDto"
        }
    }
}

Nested Schema : data

Type: array

Show Source

Array of: object VlcTmChargesServiceDTO

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

Nested Schema : PagingDto

Type: object

Show Source

totalResults: integer

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

Nested Schema : VlcTmChargesServiceDTO

Type: object

Match All

Show Source

object VlcTmChargesServiceDTO-allOf[0]

{
    "type":"object",
    "allOf":[
        {
            "type":"object",
            "properties":{
                "chargeCategory":{
                    "type":"string",
                    "description":"value can be TAX or STANDARD "
                },
                "chargeCode":{
                    "type":"string",
                    "description":"charge Code",
                    "minLength":"3",
                    "maxLength":"20",
                    "pattern":"([a-zA-Z0-9]+)?"
                },
                "chargeCodeDesc":{
                    "type":"string",
                    "description":"Charge code description"
                },
                "chargeCreditAcc":{
                    "type":"string",
                    "description":"charge credit account"
                },
                "creditTxnCode":{
                    "type":"string",
                    "description":"credit transaction code"
                },
                "debitTxnCode":{
                    "type":"string",
                    "description":"debit transaction code"
                },
                "applicationCode":{
                    "type":"string",
                    "description":"Appication for which this data is used. Possible values VAMCHG/LMCHG"
                },
                "makerId":{
                    "type":"string",
                    "description":"Maker ID of Virtual Account"
                },
                "makerDateStamp":{
                    "type":"string",
                    "description":"Date and Time when Virtual Account is created or modified or closed or reopened"
                },
                "checkerId":{
                    "type":"string",
                    "description":"Checker ID of Virtual Account"
                },
                "checkerDateStamp":{
                    "type":"string",
                    "description":"Date and Time when some action on Virtual Account is authorized"
                },
                "modNo":{
                    "type":"integer",
                    "description":"Version number of Virtual Account"
                },
                "recordStatus":{
                    "type":"string",
                    "description":"Record Status of Virtual Account"
                },
                "authStatus":{
                    "type":"string",
                    "description":"Authorization Status of Virtual Account"
                },
                "onceAuth":{
                    "type":"string",
                    "description":"Flag that indicated if Virtual Account is authorized once or not"
                },
                "doerRemarks":{
                    "type":"string",
                    "description":"Remarks made by Maker"
                },
                "approverRemarks":{
                    "type":"string",
                    "description":"Remarks made by Approver"
                }
            }
        }
    ]
}

Nested Schema : VlcTmChargesServiceDTO-allOf[0]

Type: object

Show Source

applicationCode: string

Appication for which this data is used. Possible values VAMCHG/LMCHG
approverRemarks: string

Remarks made by Approver
authStatus: string

Authorization Status of Virtual Account
chargeCategory: string

value can be TAX or STANDARD
chargeCode: string

Minimum Length: 3

Maximum Length: 20

Pattern: ([a-zA-Z0-9]+)?

charge Code
chargeCodeDesc: string

Charge code description
chargeCreditAcc: string

charge credit account
checkerDateStamp: string

Date and Time when some action on Virtual Account is authorized
checkerId: string

Checker ID of Virtual Account
creditTxnCode: string

credit transaction code
debitTxnCode: string

debit transaction code
doerRemarks: string

Remarks made by Maker
makerDateStamp: string

Date and Time when Virtual Account is created or modified or closed or reopened
makerId: string

Maker ID of Virtual Account
modNo: integer

Version number of Virtual Account
onceAuth: string

Flag that indicated if Virtual Account is authorized once or not
recordStatus: string

Record Status of Virtual Account

{
    "type":"object",
    "properties":{
        "chargeCategory":{
            "type":"string",
            "description":"value can be TAX or STANDARD "
        },
        "chargeCode":{
            "type":"string",
            "description":"charge Code",
            "minLength":"3",
            "maxLength":"20",
            "pattern":"([a-zA-Z0-9]+)?"
        },
        "chargeCodeDesc":{
            "type":"string",
            "description":"Charge code description"
        },
        "chargeCreditAcc":{
            "type":"string",
            "description":"charge credit account"
        },
        "creditTxnCode":{
            "type":"string",
            "description":"credit transaction code"
        },
        "debitTxnCode":{
            "type":"string",
            "description":"debit transaction code"
        },
        "applicationCode":{
            "type":"string",
            "description":"Appication for which this data is used. Possible values VAMCHG/LMCHG"
        },
        "makerId":{
            "type":"string",
            "description":"Maker ID of Virtual Account"
        },
        "makerDateStamp":{
            "type":"string",
            "description":"Date and Time when Virtual Account is created or modified or closed or reopened"
        },
        "checkerId":{
            "type":"string",
            "description":"Checker ID of Virtual Account"
        },
        "checkerDateStamp":{
            "type":"string",
            "description":"Date and Time when some action on Virtual Account is authorized"
        },
        "modNo":{
            "type":"integer",
            "description":"Version number of Virtual Account"
        },
        "recordStatus":{
            "type":"string",
            "description":"Record Status of Virtual Account"
        },
        "authStatus":{
            "type":"string",
            "description":"Authorization Status of Virtual Account"
        },
        "onceAuth":{
            "type":"string",
            "description":"Flag that indicated if Virtual Account is authorized once or not"
        },
        "doerRemarks":{
            "type":"string",
            "description":"Remarks made by Maker"
        },
        "approverRemarks":{
            "type":"string",
            "description":"Remarks made by Approver"
        }
    }
}

400 Response

Bad request error, the server is unable to process the request

401 Response

Unauthorized request error, invalid credentials

403 Response

Request denied, no permission to access the request..

405 Response

Request denied, invalid input

500 Response

Internal server error.