Jump to

• Request
• Response

Gets the List of Virtual and Real Accounts

get

/service/account/virtualRealAccountfetch

This endpoint is used to get the list of virtual and real accounts.

Request

Supported Media Types

• application/json
• application/xml

Query Parameters

• accountDescription: string
• accountNumber: string
• authStat: string
• branchCode: string
• currencyCode: string
• customerId: string
  Pattern: [a-zA-Z0-9]{1,20}
• iban: string
• limit: integer
  limit is maximum no of records to be fetched
• offset: integer
  offset is starting no of records to be fetched
• recordStat: string
• sourceSystem: string
• virtualOrRealAccount: string

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

Successful operation.

Body ()

Root Schema : VirtualRealAccountCollection

Type: object

Collection of account.

Show Source

• data: array data
• paging: object PagingDto

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

Nested Schema : data

Type: array

Show Source

• Array of: object VirtualRealAccountDTO

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

Nested Schema : PagingDto

Type: object

Show Source

• totalResults: integer

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

Nested Schema : VirtualRealAccountDTO

Type: object

Match All

Show Source

• object VirtualRealAccountDTO-allOf[0]

{
    "type":"object",
    "allOf":[
        {
            "type":"object",
            "properties":{
                "sourceSystem":{
                    "type":"string",
                    "description":""
                },
                "sourceSystemAccNo":{
                    "type":"string",
                    "description":""
                },
                "iban":{
                    "type":"string",
                    "description":""
                },
                "accountNumber":{
                    "type":"string",
                    "description":""
                },
                "accountDescription":{
                    "type":"string",
                    "description":""
                },
                "accountOpenDate":{
                    "type":"string",
                    "description":""
                },
                "branchCode":{
                    "type":"string",
                    "description":""
                },
                "currencyCode":{
                    "type":"string",
                    "description":""
                },
                "customerId":{
                    "type":"string",
                    "description":"",
                    "pattern":"[a-zA-Z0-9]{1,20}"
                },
                "isNoCredit":{
                    "type":"string",
                    "description":""
                },
                "isNoDebit":{
                    "type":"string",
                    "description":""
                },
                "isBlocked":{
                    "type":"string",
                    "description":""
                },
                "isDormant":{
                    "type":"string",
                    "description":""
                },
                "isFrozen":{
                    "type":"string",
                    "description":""
                },
                "accountType":{
                    "type":"string",
                    "description":""
                },
                "isVirtual":{
                    "type":"string",
                    "description":""
                },
                "accountClass":{
                    "type":"string",
                    "description":""
                }
            }
        }
    ]
}

Nested Schema : VirtualRealAccountDTO-allOf[0]

Type: object

Show Source

• accountClass: string
• accountDescription: string
• accountNumber: string
• accountOpenDate: string
• accountType: string
• branchCode: string
• currencyCode: string
• customerId: string
  Pattern: [a-zA-Z0-9]{1,20}
• iban: string
• isBlocked: string
• isDormant: string
• isFrozen: string
• isNoCredit: string
• isNoDebit: string
• isVirtual: string
• sourceSystem: string
• sourceSystemAccNo: string

{
    "type":"object",
    "properties":{
        "sourceSystem":{
            "type":"string",
            "description":""
        },
        "sourceSystemAccNo":{
            "type":"string",
            "description":""
        },
        "iban":{
            "type":"string",
            "description":""
        },
        "accountNumber":{
            "type":"string",
            "description":""
        },
        "accountDescription":{
            "type":"string",
            "description":""
        },
        "accountOpenDate":{
            "type":"string",
            "description":""
        },
        "branchCode":{
            "type":"string",
            "description":""
        },
        "currencyCode":{
            "type":"string",
            "description":""
        },
        "customerId":{
            "type":"string",
            "description":"",
            "pattern":"[a-zA-Z0-9]{1,20}"
        },
        "isNoCredit":{
            "type":"string",
            "description":""
        },
        "isNoDebit":{
            "type":"string",
            "description":""
        },
        "isBlocked":{
            "type":"string",
            "description":""
        },
        "isDormant":{
            "type":"string",
            "description":""
        },
        "isFrozen":{
            "type":"string",
            "description":""
        },
        "accountType":{
            "type":"string",
            "description":""
        },
        "isVirtual":{
            "type":"string",
            "description":""
        },
        "accountClass":{
            "type":"string",
            "description":""
        }
    }
}

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