REST API for Oracle Banking Virtual Account Management

Adds a new remitter ids

post

/service/remitters

This endpoint is used to add new remittance IDs.

Request

Supported Media Types

application/json
application/xml

Header Parameters

sourceCode: string

Source from which request is initiated

Request Body that contains data required for creating a new remitterids

Root Schema : RemitterIdServiceRequestDataDTO

Type: object

Match All

Show Source

object RemitterIdServiceRequestDataDTO-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
                },
                "virtualIdentifier":{
                    "type":"string",
                    "description":"Virtual Identifier",
                    "minLength":1,
                    "maxLength":15
                },
                "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]+$"
                },
                "ibanReqd":{
                    "type":"string",
                    "description":"Flag that indicates if IBAN is to be generated or not"
                },
                "additionalInfo":{
                    "type":"string",
                    "description":"Additional information provided by corporate for further use "
                },
                "reconInfo":{
                    "type":"string",
                    "description":"Reference number provided by corporate for reconciliation purpose"
                },
                "validityStartDate":{
                    "type":"string",
                    "description":"Date from which Remitter id will be active"
                },
                "validityEndDate":{
                    "type":"string",
                    "description":"Date till which Remitter id will be active"
                }
            },
            "required":[
                "realCustomerNo",
                "remitterId",
                "virtualIdentifier"
            ]
        }
    ]
}

Nested Schema : RemitterIdServiceRequestDataDTO-allOf[0]

Type: object

Show Source

additionalInfo(optional): string

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

Flag that indicates if IBAN is to be generated or not
realCustomerNo: string

Minimum Length: 1

Maximum Length: 20

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

Reference number provided by corporate for reconciliation purpose
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
validityEndDate(optional): string

Date till which Remitter id will be active
validityStartDate(optional): string

Date from which Remitter id will be active
virtualIdentifier: string

Minimum Length: 1

Maximum Length: 15

Virtual Identifier

{
    "type":"object",
    "properties":{
        "realCustomerNo":{
            "type":"string",
            "description":"Customer number for which Remitter list id is maintained",
            "minLength":1,
            "maxLength":20
        },
        "virtualIdentifier":{
            "type":"string",
            "description":"Virtual Identifier",
            "minLength":1,
            "maxLength":15
        },
        "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]+$"
        },
        "ibanReqd":{
            "type":"string",
            "description":"Flag that indicates if IBAN is to be generated or not"
        },
        "additionalInfo":{
            "type":"string",
            "description":"Additional information provided by corporate for further use "
        },
        "reconInfo":{
            "type":"string",
            "description":"Reference number provided by corporate for reconciliation purpose"
        },
        "validityStartDate":{
            "type":"string",
            "description":"Date from which Remitter id will be active"
        },
        "validityEndDate":{
            "type":"string",
            "description":"Date till which Remitter id will be active"
        }
    },
    "required":[
        "realCustomerNo",
        "remitterId",
        "virtualIdentifier"
    ]
}

Response

Supported Media Types

application/json
application/xml

201 Response

Returns message of succes or failure

Headers

Location: string

URL of newly created remitterids

Root Schema : RemitterIdServiceResponseDtoWrapper

Type: object

Show Source

data(optional): object RemitterIdServiceResponseDataDto
messages(optional): object RemitterIdServiceResponseDto

{
    "type":"object",
    "properties":{
        "messages":{
            "$ref":"#/definitions/RemitterIdServiceResponseDto"
        },
        "data":{
            "$ref":"#/definitions/RemitterIdServiceResponseDataDto"
        }
    }
}

Nested Schema : RemitterIdServiceResponseDataDto

Type: object

Match All

Show Source

object RemitterIdServiceResponseDataDto-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
                },
                "virtualIdentifier":{
                    "type":"string",
                    "description":"Virtual Identifier",
                    "minLength":1,
                    "maxLength":15
                },
                "remitterListId":{
                    "type":"string",
                    "description":"Unique identification number to identify Remitter list",
                    "minLength":1,
                    "maxLength":35,
                    "pattern":"^[a-zA-Z0-9]+$"
                },
                "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]+$"
                },
                "identifierAccountNo":{
                    "type":"string",
                    "description":"Identifier Account which is VirtualIdentifier + remitterId"
                },
                "ibanReqd":{
                    "type":"string",
                    "description":"Flag that indicates if IBAN is to be generated or not"
                },
                "ibanAccountNo":{
                    "type":"string",
                    "description":"IBAN for the Identifier"
                },
                "additionalInfo":{
                    "type":"string",
                    "description":"Additional information provided by corporate for further use "
                },
                "reconInfo":{
                    "type":"string",
                    "description":"Reference number provided by corporate for reconciliation purpose"
                },
                "validityStartDate":{
                    "type":"string",
                    "description":"Date from which Remitter id will be active"
                },
                "validityEndDate":{
                    "type":"string",
                    "description":"Date till which Remitter id will be active"
                },
                "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"
                }
            }
        }
    ]
}

Nested Schema : RemitterIdServiceResponseDto

Type: object

Show Source

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

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

Nested Schema : RemitterIdServiceResponseDataDto-allOf[0]

Type: object

Show Source

additionalInfo(optional): string

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

Authorization Status of Virtual Account
checkerDateStamp(optional): string

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

Checker ID of Virtual Account
ibanAccountNo(optional): string

IBAN for the Identifier
ibanReqd(optional): string

Flag that indicates if IBAN is to be generated or not
identifierAccountNo(optional): string

Identifier Account which is VirtualIdentifier + remitterId
makerDateStamp(optional): string

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

Maker ID of Virtual Account
modNo(optional): integer

Version number of Virtual Account
onceAuth(optional): string

Flag that indicated if Virtual Account is authorized once or not
realCustomerNo(optional): string

Minimum Length: 1

Maximum Length: 20

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

Reference number provided by corporate for reconciliation purpose
recordStatus(optional): string

Record Status of Virtual Account
remitterId(optional): 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(optional): string

Minimum Length: 1

Maximum Length: 35

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

Unique identification number to identify Remitter list
validityEndDate(optional): string

Date till which Remitter id will be active
validityStartDate(optional): string

Date from which Remitter id will be active
virtualIdentifier(optional): string

Minimum Length: 1

Maximum Length: 15

Virtual Identifier

{
    "type":"object",
    "properties":{
        "realCustomerNo":{
            "type":"string",
            "description":"Customer number for which Remitter list id is maintained",
            "minLength":1,
            "maxLength":20
        },
        "virtualIdentifier":{
            "type":"string",
            "description":"Virtual Identifier",
            "minLength":1,
            "maxLength":15
        },
        "remitterListId":{
            "type":"string",
            "description":"Unique identification number to identify Remitter list",
            "minLength":1,
            "maxLength":35,
            "pattern":"^[a-zA-Z0-9]+$"
        },
        "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]+$"
        },
        "identifierAccountNo":{
            "type":"string",
            "description":"Identifier Account which is VirtualIdentifier + remitterId"
        },
        "ibanReqd":{
            "type":"string",
            "description":"Flag that indicates if IBAN is to be generated or not"
        },
        "ibanAccountNo":{
            "type":"string",
            "description":"IBAN for the Identifier"
        },
        "additionalInfo":{
            "type":"string",
            "description":"Additional information provided by corporate for further use "
        },
        "reconInfo":{
            "type":"string",
            "description":"Reference number provided by corporate for reconciliation purpose"
        },
        "validityStartDate":{
            "type":"string",
            "description":"Date from which Remitter id will be active"
        },
        "validityEndDate":{
            "type":"string",
            "description":"Date till which Remitter id will be active"
        },
        "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"
        }
    }
}

Nested Schema : codes

Type: array

Show Source

Array of: object RemitterIdServiceResponseCode

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

Nested Schema : RemitterIdServiceResponseCode

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