REST API for Oracle Banking Virtual Account Management

Update an existing remitter ids

put

/service/remitterids/{remitterListId}

This endpoint is used to update an existing remittance IDs.

Request

Supported Media Types

application/json

Path Parameters

remitterListId: string

remitterListId of the remitterids Maintenance

Header Parameters

sourceCode: string

Source from which request is initiated

Request Body that contains data required for updating an existing remitterids

Root Schema : RemitterIdMasterServiceSaveDTO

Type: object

Match All

Show Source

object RemitterIdMasterServiceSaveDTO-allOf[0]


{
    "type":"object",
    "allOf":[
        {
            "type":"object",
            "properties":{
                "realCustomerNo":{
                    "type":"string",
                    "description":"Customer number for which Remitter list id is maintained",
                    "minLength":1,
                    "maxLength":20
                },
                "realCustomerName":{
                    "type":"string",
                    "description":"Customer Name for which Remitter list id is maintained"
                },
                "remitterDesc":{
                    "type":"string",
                    "description":"Description of Remitter list id",
                    "minLength":1,
                    "maxLength":255
                },
                "remitterListId":{
                    "type":"string",
                    "description":"Unique identification number to identify Remitter list",
                    "minLength":1,
                    "maxLength":35,
                    "pattern":"^[a-zA-Z0-9]+$"
                },
                "RemitterIdDetailServiceSaveDTO":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/RemitterIdDetailServiceSaveDTO"
                    }
                }
            },
            "required":[
                "realCustomerNo",
                "remitterListId"
            ]
        }
    ]
}

Nested Schema : RemitterIdMasterServiceSaveDTO-allOf[0]

Type: object

Show Source

realCustomerName(optional): string

Customer Name for which Remitter list id is maintained
realCustomerNo: string

Minimum Length: 1

Maximum Length: 20

Customer number for which Remitter list id is maintained
remitterDesc(optional): string

Minimum Length: 1

Maximum Length: 255

Description of Remitter list id
RemitterIdDetailServiceSaveDTO(optional): array RemitterIdDetailServiceSaveDTO
remitterListId: string

Minimum Length: 1

Maximum Length: 35

Pattern: ^[a-zA-Z0-9]+$

Unique identification number to identify Remitter list


{
    "type":"object",
    "properties":{
        "realCustomerNo":{
            "type":"string",
            "description":"Customer number for which Remitter list id is maintained",
            "minLength":1,
            "maxLength":20
        },
        "realCustomerName":{
            "type":"string",
            "description":"Customer Name for which Remitter list id is maintained"
        },
        "remitterDesc":{
            "type":"string",
            "description":"Description of Remitter list id",
            "minLength":1,
            "maxLength":255
        },
        "remitterListId":{
            "type":"string",
            "description":"Unique identification number to identify Remitter list",
            "minLength":1,
            "maxLength":35,
            "pattern":"^[a-zA-Z0-9]+$"
        },
        "RemitterIdDetailServiceSaveDTO":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/RemitterIdDetailServiceSaveDTO"
            }
        }
    },
    "required":[
        "realCustomerNo",
        "remitterListId"
    ]
}

Nested Schema : RemitterIdDetailServiceSaveDTO

Type: array

Show Source

Array of: object RemitterIdDetailServiceSaveDTO


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

Nested Schema : RemitterIdDetailServiceSaveDTO

Type: object

Show Source

additionalInfo(optional): string

Additional information provided by corporate for further use
reconInfo(optional): string

Reference number provided by corporate for reconciliation purpose
recordStatus: string

Minimum Length: 1

Maximum Length: 1

Indicates status of the Remitter id
remitterId: string

Minimum Length: 1

Maximum Length: 35

Pattern: ^[a-zA-Z0-9]+$

Identification number of the Remitter which is the second part of the VAI account number
remitterListId: string

Unique identification number to identify Remitter list
validityEndDate: string

Date till which Remitter id will be active
validityStartDate: string

Date from which Remitter id will be active


{
    "type":"object",
    "properties":{
        "additionalInfo":{
            "type":"string",
            "description":"Additional information provided by corporate for further use "
        },
        "reconInfo":{
            "type":"string",
            "description":"Reference number provided by corporate for reconciliation purpose"
        },
        "recordStatus":{
            "type":"string",
            "description":"Indicates status of the Remitter id",
            "minLength":1,
            "maxLength":1
        },
        "validityEndDate":{
            "type":"string",
            "description":"Date till which Remitter id will be active"
        },
        "validityStartDate":{
            "type":"string",
            "description":"Date from which Remitter id will be active"
        },
        "remitterId":{
            "type":"string",
            "description":"Identification number of the Remitter which is the second part of the VAI account number",
            "minLength":1,
            "maxLength":35,
            "pattern":"^[a-zA-Z0-9]+$"
        },
        "remitterListId":{
            "type":"string",
            "description":"Unique identification number to identify Remitter list"
        }
    },
    "required":[
        "recordStatus",
        "validityEndDate",
        "validityStartDate",
        "remitterId",
        "remitterListId"
    ]
}

Response

Supported Media Types

application/json

200 Response

Returns updated remitterids

Root Schema : RemitterIdMasterResponseDtoWrapper

Type: object

Show Source

data(optional): object RemitterIdMasterServiceDTO
messages(optional): object RemitterIdMasterResponseDto


{
    "type":"object",
    "properties":{
        "messages":{
            "$ref":"#/definitions/RemitterIdMasterResponseDto"
        },
        "data":{
            "$ref":"#/definitions/RemitterIdMasterServiceDTO"
        }
    }
}

Nested Schema : RemitterIdMasterServiceDTO

Type: object

Match All

Show Source

object RemitterIdMasterServiceDTO-allOf[0]


{
    "type":"object",
    "allOf":[
        {
            "type":"object",
            "properties":{
                "realCustomerNo":{
                    "type":"string",
                    "description":"Customer number for which Remitter list id is maintained",
                    "minLength":1,
                    "maxLength":20
                },
                "realCustomerName":{
                    "type":"string",
                    "description":"Customer Name for which Remitter list id is maintained"
                },
                "remitterDesc":{
                    "type":"string",
                    "description":"Description of Remitter list id",
                    "minLength":1,
                    "maxLength":255
                },
                "remitterListId":{
                    "type":"string",
                    "description":"Unique identification number to identify Remitter list",
                    "minLength":1,
                    "maxLength":35,
                    "pattern":"^[a-zA-Z0-9]+$"
                },
                "makerId":{
                    "type":"string",
                    "description":"Maker ID"
                },
                "makerDateStamp":{
                    "type":"string",
                    "description":"Maker Date Stamp"
                },
                "checkerId":{
                    "type":"string",
                    "description":"Checker ID"
                },
                "checkerDateStamp":{
                    "type":"string",
                    "description":"Checker Date Stamp"
                },
                "modNo":{
                    "type":"number",
                    "format":"int64",
                    "description":"Mod Number"
                },
                "recordStatus":{
                    "type":"string",
                    "description":"Record Status"
                },
                "authStatus":{
                    "type":"string",
                    "description":"Auth Status"
                },
                "onceAuth":{
                    "type":"string",
                    "description":"Once Authorized"
                },
                "doerRemarks":{
                    "type":"string",
                    "description":"Maker Remarks"
                },
                "approverRemarks":{
                    "type":"string",
                    "description":"Checker Remarks"
                },
                "RemitterIdDetailServiceDTO":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/RemitterIdDetailServiceDTO"
                    }
                }
            },
            "required":[
                "realCustomerNo",
                "remitterListId"
            ]
        }
    ]
}

Nested Schema : RemitterIdMasterResponseDto

Type: object

Show Source

codes(optional): array codes
status(optional): string


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

Nested Schema : RemitterIdMasterServiceDTO-allOf[0]

Type: object

Show Source

approverRemarks(optional): string

Checker Remarks
authStatus(optional): string

Auth Status
checkerDateStamp(optional): string

Checker Date Stamp
checkerId(optional): string

Checker ID
doerRemarks(optional): string

Maker Remarks
makerDateStamp(optional): string

Maker Date Stamp
makerId(optional): string

Maker ID
modNo(optional): number(int64)

Mod Number
onceAuth(optional): string

Once Authorized
realCustomerName(optional): string

Customer Name for which Remitter list id is maintained
realCustomerNo: string

Minimum Length: 1

Maximum Length: 20

Customer number for which Remitter list id is maintained
recordStatus(optional): string

Record Status
remitterDesc(optional): string

Minimum Length: 1

Maximum Length: 255

Description of Remitter list id
RemitterIdDetailServiceDTO(optional): array RemitterIdDetailServiceDTO
remitterListId: string

Minimum Length: 1

Maximum Length: 35

Pattern: ^[a-zA-Z0-9]+$

Unique identification number to identify Remitter list


{
    "type":"object",
    "properties":{
        "realCustomerNo":{
            "type":"string",
            "description":"Customer number for which Remitter list id is maintained",
            "minLength":1,
            "maxLength":20
        },
        "realCustomerName":{
            "type":"string",
            "description":"Customer Name for which Remitter list id is maintained"
        },
        "remitterDesc":{
            "type":"string",
            "description":"Description of Remitter list id",
            "minLength":1,
            "maxLength":255
        },
        "remitterListId":{
            "type":"string",
            "description":"Unique identification number to identify Remitter list",
            "minLength":1,
            "maxLength":35,
            "pattern":"^[a-zA-Z0-9]+$"
        },
        "makerId":{
            "type":"string",
            "description":"Maker ID"
        },
        "makerDateStamp":{
            "type":"string",
            "description":"Maker Date Stamp"
        },
        "checkerId":{
            "type":"string",
            "description":"Checker ID"
        },
        "checkerDateStamp":{
            "type":"string",
            "description":"Checker Date Stamp"
        },
        "modNo":{
            "type":"number",
            "format":"int64",
            "description":"Mod Number"
        },
        "recordStatus":{
            "type":"string",
            "description":"Record Status"
        },
        "authStatus":{
            "type":"string",
            "description":"Auth Status"
        },
        "onceAuth":{
            "type":"string",
            "description":"Once Authorized"
        },
        "doerRemarks":{
            "type":"string",
            "description":"Maker Remarks"
        },
        "approverRemarks":{
            "type":"string",
            "description":"Checker Remarks"
        },
        "RemitterIdDetailServiceDTO":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/RemitterIdDetailServiceDTO"
            }
        }
    },
    "required":[
        "realCustomerNo",
        "remitterListId"
    ]
}

Nested Schema : RemitterIdDetailServiceDTO

Type: array

Show Source

Array of: object RemitterIdDetailServiceDTO


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

Nested Schema : RemitterIdDetailServiceDTO

Type: object

Show Source

additionalInfo(optional): string

Additional information provided by corporate for further use
reconInfo(optional): string

Reference number provided by corporate for reconciliation purpose
recordStatus: string

Minimum Length: 1

Maximum Length: 1

Indicates status of the Remitter id
remitterId: string

Minimum Length: 1

Maximum Length: 35

Pattern: ^[a-zA-Z0-9]+$

Identification number of the Remitter which is the second part of the VAI account number
remitterListId: string

Unique identification number to identify Remitter list
validityEndDate: string

Date till which Remitter id will be active
validityStartDate: string

Date from which Remitter id will be active


{
    "type":"object",
    "properties":{
        "additionalInfo":{
            "type":"string",
            "description":"Additional information provided by corporate for further use "
        },
        "reconInfo":{
            "type":"string",
            "description":"Reference number provided by corporate for reconciliation purpose"
        },
        "recordStatus":{
            "type":"string",
            "description":"Indicates status of the Remitter id",
            "minLength":1,
            "maxLength":1
        },
        "validityEndDate":{
            "type":"string",
            "description":"Date till which Remitter id will be active"
        },
        "validityStartDate":{
            "type":"string",
            "description":"Date from which Remitter id will be active"
        },
        "remitterId":{
            "type":"string",
            "description":"Identification number of the Remitter which is the second part of the VAI account number",
            "minLength":1,
            "maxLength":35,
            "pattern":"^[a-zA-Z0-9]+$"
        },
        "remitterListId":{
            "type":"string",
            "description":"Unique identification number to identify Remitter list"
        }
    },
    "required":[
        "recordStatus",
        "validityEndDate",
        "validityStartDate",
        "remitterId",
        "remitterListId"
    ]
}

Nested Schema : codes

Type: array

Show Source

Array of: object RemitterIdMasterResponseCode


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

Nested Schema : RemitterIdMasterResponseCode

Type: object

Show Source

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"
        }
    }
}

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

Oracle Account

Oracle Account

Sign in to Cloud

REST API for Oracle Banking Virtual Account Management

Update an existing remitter ids

Request

Response

200 Response

400 Response

401 Response

403 Response

405 Response

500 Response