REST API for Oracle Banking Virtual Account Management Cloud Service

Add/update the account transaction restriction

post

/service/acctxnrestriction

This endpoint is used to add /edit the transaction restriction at account level.

Request

Supported Media Types

application/json
application/xml

Header Parameters

sourceCode(required): string

source code

Request Body that contains data required for acctxnrestriction

Root Schema : VamTmAccountTxnRestrSaveServiceDTO

Type: object

Match All

Show Source

object VamTmAccountTxnRestrSaveServiceDTO-allOf[0]

{
    "type":"object",
    "allOf":[
        {
            "type":"object",
            "properties":{
                "limitCode":{
                    "type":"string",
                    "description":"Limit code"
                },
                "virtualAccountNo":{
                    "type":"string",
                    "description":"Virtual account number"
                },
                "VamTmAccountTxnRestrDetailServiceDTO":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/VamTmAccountTxnRestrDetailSaveDTO"
                    }
                }
            },
            "required":[
                "limitCode",
                "virtualAccountNo"
            ]
        }
    ]
}

Nested Schema : VamTmAccountTxnRestrSaveServiceDTO-allOf[0]

Type: object

Show Source

limitCode(required): string

Limit code
VamTmAccountTxnRestrDetailServiceDTO: array VamTmAccountTxnRestrDetailServiceDTO
virtualAccountNo(required): string

Virtual account number

{
    "type":"object",
    "properties":{
        "limitCode":{
            "type":"string",
            "description":"Limit code"
        },
        "virtualAccountNo":{
            "type":"string",
            "description":"Virtual account number"
        },
        "VamTmAccountTxnRestrDetailServiceDTO":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/VamTmAccountTxnRestrDetailSaveDTO"
            }
        }
    },
    "required":[
        "limitCode",
        "virtualAccountNo"
    ]
}

Nested Schema : VamTmAccountTxnRestrDetailServiceDTO

Type: array

Show Source

Array of: object VamTmAccountTxnRestrDetailSaveDTO

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

Nested Schema : VamTmAccountTxnRestrDetailSaveDTO

Type: object

Show Source

count(required): number

allowed count of transaction for the specific restriction
restrictionId(required): string

the restriction id for which count is getting captured

{
    "type":"object",
    "properties":{
        "count":{
            "type":"number",
            "description":"allowed count of transaction for the specific restriction"
        },
        "restrictionId":{
            "type":"string",
            "description":"the restriction id for which count is getting captured"
        }
    },
    "required":[
        "count",
        "restrictionId"
    ]
}

Response

Supported Media Types

application/json
text/csv
application/xml

201 Response

Returns message of succes or failure

Headers

Location: string

URL of newly created acctxnrestriction

Root Schema : AcctTxnRestrResponseDtoWrapper

Type: object

Show Source

data: object VamTmAccountTxnRestrMasterServiceDTO
messages: object AcctTxnRestrServiceResponseDto

{
    "type":"object",
    "properties":{
        "messages":{
            "$ref":"#/definitions/AcctTxnRestrServiceResponseDto"
        },
        "data":{
            "$ref":"#/definitions/VamTmAccountTxnRestrMasterServiceDTO"
        }
    }
}

Nested Schema : VamTmAccountTxnRestrMasterServiceDTO

Type: object

Match All

Show Source

object VamTmAccountTxnRestrMasterServiceDTO-allOf[0]

{
    "type":"object",
    "allOf":[
        {
            "type":"object",
            "properties":{
                "limitCode":{
                    "type":"string",
                    "description":"Limit code"
                },
                "virtualAccountNo":{
                    "type":"string",
                    "description":"Virtual account number"
                },
                "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"
                },
                "VamTmAccountTxnRestrDetailServiceDTO":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/VamTmAccountTxnRestrDetailServiceDTO"
                    }
                }
            },
            "required":[
                "limitCode",
                "virtualAccountNo"
            ]
        }
    ]
}

Nested Schema : AcctTxnRestrServiceResponseDto

Type: object

Show Source

codes: array codes
status: string

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

Nested Schema : VamTmAccountTxnRestrMasterServiceDTO-allOf[0]

Type: object

Show Source

approverRemarks: string

Remarks made by Approver
authStatus: string

Authorization Status of Virtual Account
checkerDateStamp: string

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

Checker ID of Virtual Account
doerRemarks: string

Remarks made by Maker
limitCode(required): string

Limit code
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
VamTmAccountTxnRestrDetailServiceDTO: array VamTmAccountTxnRestrDetailServiceDTO
virtualAccountNo(required): string

Virtual account number

{
    "type":"object",
    "properties":{
        "limitCode":{
            "type":"string",
            "description":"Limit code"
        },
        "virtualAccountNo":{
            "type":"string",
            "description":"Virtual account number"
        },
        "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"
        },
        "VamTmAccountTxnRestrDetailServiceDTO":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/VamTmAccountTxnRestrDetailServiceDTO"
            }
        }
    },
    "required":[
        "limitCode",
        "virtualAccountNo"
    ]
}

Nested Schema : VamTmAccountTxnRestrDetailServiceDTO

Type: array

Show Source

Array of: object VamTmAccountTxnRestrDetailServiceDTO

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

Nested Schema : VamTmAccountTxnRestrDetailServiceDTO

Type: object

Show Source

count(required): number

allowed count of transaction for the specific restriction
restrictionId(required): string

the restriction id for which count is getting captured
virtualAccountNo: string

virtual account number

{
    "type":"object",
    "properties":{
        "count":{
            "type":"number",
            "description":"allowed count of transaction for the specific restriction"
        },
        "restrictionId":{
            "type":"string",
            "description":"the restriction id for which count is getting captured"
        },
        "virtualAccountNo":{
            "type":"string",
            "description":"virtual account number"
        }
    },
    "required":[
        "count",
        "restrictionId"
    ]
}

Nested Schema : codes

Type: array

Show Source

Array of: object AcctTxnRestrServiceResponseCode

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

Nested Schema : AcctTxnRestrServiceResponseCode

Type: object

Show Source

Code: string
Desc: string
Language: string
Type: string

{
    "type":"object",
    "properties":{
        "Code":{
            "type":"string"
        },
        "Desc":{
            "type":"string"
        },
        "Type":{
            "type":"string"
        },
        "Language":{
            "type":"string"
        }
    }
}

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