Jump to

• Request
• Response

Retrieves the core virtual accounts by natural key

get

/service/corevirtualaccounts/{virtualAccountNo}

This endpoint is used to retrieve the core virtual accounts by natural key.

Request

Supported Media Types

• application/json

Path Parameters

• virtualAccountNo: string
  Virtual Account Number

Back to Top

Response

Supported Media Types

• application/json

200 Response

Returns the corevirtualaccounts based on given natural key.

Body ()

Root Schema : CmcTmCoreVirtualAccountWrapperServiceDTO

Type: object

Show Source

• data(optional): object CmcTmCoreVirtualAccountResponseDTO

{
    "type":"object",
    "properties":{
        "data":{
            "$ref":"#/definitions/CmcTmCoreVirtualAccountResponseDTO"
        }
    }
}

Nested Schema : CmcTmCoreVirtualAccountResponseDTO

Type: object

Match All

Show Source

• object CmcTmCoreVirtualAccountResponseDTO-allOf[0]

{
    "type":"object",
    "allOf":[
        {
            "type":"object",
            "properties":{
                "accountClass":{
                    "type":"string",
                    "description":"Account class of the external virtual account"
                },
                "acOpenDate":{
                    "type":"string",
                    "description":"The date on which virtual account is being opened"
                },
                "acStatFrozen":{
                    "type":"string",
                    "description":"Indicates that the virtual account status is frozen",
                    "minLength":0,
                    "maxLength":1,
                    "pattern":"[Y,N]"
                },
                "acStatNoCr":{
                    "type":"string",
                    "description":"Indicates that the virtual account does not have any credit facility",
                    "minLength":0,
                    "maxLength":1,
                    "pattern":"[Y,N]"
                },
                "acStatNoDr":{
                    "type":"string",
                    "description":"Indicates that the virtual account does not have any debit facility",
                    "minLength":0,
                    "maxLength":1,
                    "pattern":"[Y,N]"
                },
                "address1":{
                    "type":"string",
                    "description":"First line of the address",
                    "minLength":0,
                    "maxLength":105
                },
                "address2":{
                    "type":"string",
                    "description":"Second line of the address",
                    "minLength":0,
                    "maxLength":105
                },
                "address3":{
                    "type":"string",
                    "description":"Third line of the address",
                    "minLength":0,
                    "maxLength":105
                },
                "address4":{
                    "type":"string",
                    "description":"Fourth line of the address",
                    "minLength":0,
                    "maxLength":105
                },
                "countryCode":{
                    "type":"string",
                    "description":"Country Code",
                    "minLength":0,
                    "maxLength":4
                },
                "customerNo":{
                    "type":"string",
                    "description":"Customer number to which the virtual account number is being linked",
                    "minLength":0,
                    "maxLength":20
                },
                "ecaCheckReq":{
                    "type":"string",
                    "description":"Indicates that ECA check is required for the external virtual account",
                    "minLength":0,
                    "maxLength":1,
                    "pattern":"[Y,N]"
                },
                "hostCode":{
                    "type":"string",
                    "description":"The host code that is linked to the logged in user of the branch"
                },
                "isForgotten":{
                    "type":"string",
                    "description":"Indicates that the customer is forgotten",
                    "minLength":0,
                    "maxLength":1,
                    "pattern":"[Y,N]"
                },
                "sourceSystem":{
                    "type":"string",
                    "description":"Name of the source system"
                },
                "sourceSystemAccBrn":{
                    "type":"string",
                    "description":"Branch to which the account belongs to"
                },
                "sourceSystemAccNo":{
                    "type":"string",
                    "description":"Virtual account number as in the source system"
                },
                "virtualAccountNo":{
                    "type":"string",
                    "description":"External virtual account number",
                    "minLength":1,
                    "maxLength":35
                },
                "virtualAcCcy":{
                    "type":"string",
                    "description":"Currency in which the virtual account is being created",
                    "minLength":1,
                    "maxLength":3
                },
                "virtualAcName":{
                    "type":"string",
                    "description":"Name of the virtual account holder",
                    "minLength":0,
                    "maxLength":105,
                    "pattern":"[a-zA-Z0-9\\s]+"
                },
                "virtualIban":{
                    "type":"string",
                    "description":"Virtual IBAN as in the source system",
                    "minLength":0,
                    "maxLength":35,
                    "pattern":"[a-zA-Z0-9]+"
                },
                "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 : CmcTmCoreVirtualAccountResponseDTO-allOf[0]

Type: object

Show Source

• accountClass(optional): string
  Account class of the external virtual account
• acOpenDate(optional): string
  The date on which virtual account is being opened
• acStatFrozen(optional): string
  Minimum Length: 0

  Maximum Length: 1

  Pattern: [Y,N]

  Indicates that the virtual account status is frozen
• acStatNoCr(optional): string
  Minimum Length: 0

  Maximum Length: 1

  Pattern: [Y,N]

  Indicates that the virtual account does not have any credit facility
• acStatNoDr(optional): string
  Minimum Length: 0

  Maximum Length: 1

  Pattern: [Y,N]

  Indicates that the virtual account does not have any debit facility
• address1(optional): string
  Minimum Length: 0

  Maximum Length: 105

  First line of the address
• address2(optional): string
  Minimum Length: 0

  Maximum Length: 105

  Second line of the address
• address3(optional): string
  Minimum Length: 0

  Maximum Length: 105

  Third line of the address
• address4(optional): string
  Minimum Length: 0

  Maximum Length: 105

  Fourth line of the address
• approverRemarks(optional): string
  Remarks made by Approver
• 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
• countryCode(optional): string
  Minimum Length: 0

  Maximum Length: 4

  Country Code
• customerNo(optional): string
  Minimum Length: 0

  Maximum Length: 20

  Customer number to which the virtual account number is being linked
• doerRemarks(optional): string
  Remarks made by Maker
• ecaCheckReq(optional): string
  Minimum Length: 0

  Maximum Length: 1

  Pattern: [Y,N]

  Indicates that ECA check is required for the external virtual account
• hostCode(optional): string
  The host code that is linked to the logged in user of the branch
• isForgotten(optional): string
  Minimum Length: 0

  Maximum Length: 1

  Pattern: [Y,N]

  Indicates that the customer is forgotten
• 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
• recordStatus(optional): string
  Record Status of Virtual Account
• sourceSystem(optional): string
  Name of the source system
• sourceSystemAccBrn(optional): string
  Branch to which the account belongs to
• sourceSystemAccNo(optional): string
  Virtual account number as in the source system
• virtualAcCcy(optional): string
  Minimum Length: 1

  Maximum Length: 3

  Currency in which the virtual account is being created
• virtualAccountNo(optional): string
  Minimum Length: 1

  Maximum Length: 35

  External virtual account number
• virtualAcName(optional): string
  Minimum Length: 0

  Maximum Length: 105

  Pattern: [a-zA-Z0-9\s]+

  Name of the virtual account holder
• virtualIban(optional): string
  Minimum Length: 0

  Maximum Length: 35

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

  Virtual IBAN as in the source system

{
    "type":"object",
    "properties":{
        "accountClass":{
            "type":"string",
            "description":"Account class of the external virtual account"
        },
        "acOpenDate":{
            "type":"string",
            "description":"The date on which virtual account is being opened"
        },
        "acStatFrozen":{
            "type":"string",
            "description":"Indicates that the virtual account status is frozen",
            "minLength":0,
            "maxLength":1,
            "pattern":"[Y,N]"
        },
        "acStatNoCr":{
            "type":"string",
            "description":"Indicates that the virtual account does not have any credit facility",
            "minLength":0,
            "maxLength":1,
            "pattern":"[Y,N]"
        },
        "acStatNoDr":{
            "type":"string",
            "description":"Indicates that the virtual account does not have any debit facility",
            "minLength":0,
            "maxLength":1,
            "pattern":"[Y,N]"
        },
        "address1":{
            "type":"string",
            "description":"First line of the address",
            "minLength":0,
            "maxLength":105
        },
        "address2":{
            "type":"string",
            "description":"Second line of the address",
            "minLength":0,
            "maxLength":105
        },
        "address3":{
            "type":"string",
            "description":"Third line of the address",
            "minLength":0,
            "maxLength":105
        },
        "address4":{
            "type":"string",
            "description":"Fourth line of the address",
            "minLength":0,
            "maxLength":105
        },
        "countryCode":{
            "type":"string",
            "description":"Country Code",
            "minLength":0,
            "maxLength":4
        },
        "customerNo":{
            "type":"string",
            "description":"Customer number to which the virtual account number is being linked",
            "minLength":0,
            "maxLength":20
        },
        "ecaCheckReq":{
            "type":"string",
            "description":"Indicates that ECA check is required for the external virtual account",
            "minLength":0,
            "maxLength":1,
            "pattern":"[Y,N]"
        },
        "hostCode":{
            "type":"string",
            "description":"The host code that is linked to the logged in user of the branch"
        },
        "isForgotten":{
            "type":"string",
            "description":"Indicates that the customer is forgotten",
            "minLength":0,
            "maxLength":1,
            "pattern":"[Y,N]"
        },
        "sourceSystem":{
            "type":"string",
            "description":"Name of the source system"
        },
        "sourceSystemAccBrn":{
            "type":"string",
            "description":"Branch to which the account belongs to"
        },
        "sourceSystemAccNo":{
            "type":"string",
            "description":"Virtual account number as in the source system"
        },
        "virtualAccountNo":{
            "type":"string",
            "description":"External virtual account number",
            "minLength":1,
            "maxLength":35
        },
        "virtualAcCcy":{
            "type":"string",
            "description":"Currency in which the virtual account is being created",
            "minLength":1,
            "maxLength":3
        },
        "virtualAcName":{
            "type":"string",
            "description":"Name of the virtual account holder",
            "minLength":0,
            "maxLength":105,
            "pattern":"[a-zA-Z0-9\\s]+"
        },
        "virtualIban":{
            "type":"string",
            "description":"Virtual IBAN as in the source system",
            "minLength":0,
            "maxLength":35,
            "pattern":"[a-zA-Z0-9]+"
        },
        "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

Malformed syntax.

401 Response

Request does not have sufficient credentials.

403 Response

Request is not authorized.

500 Response

Internal error

Back to Top