Jump to

• Request
• Response

Get all valid virtual accounts allowed as transfer account

get

/service/accounts/virtualaccountsfortransfer/{closureVirAcc}

This endpoint is used to get all valid virtual accounts allowed as transfer account.

Request

Supported Media Types

• application/json

Path Parameters

• closureVirAcc: string
  Virtual account for which siblings needs to be fetched

Query Parameters

• ibanAccNo(optional): string
  International Bank Account Number
• limit(optional): integer
  limit is maximum no of records to be fetched
• offset(optional): integer
  offset is starting no of records to be fetched
• virtualAccountName(optional): string
  Description of the virtual Account
• virtualAccountNo(optional): string
  Virtual account number to or from which funds can be transferred

Back to Top

Response

Supported Media Types

• application/json

201 Response

Returns message of success or failure

Headers

• Location: string

Body ()

Root Schema : TransferVirtualAccountsCollection

Type: object

Collection of virtual account allowed for closure

Show Source

• data(optional): array data
• messages(optional): object TransferVirtualAccountResponseDTO
• paging(optional): object PagingDto

{
    "description":"Collection of virtual account allowed for closure",
    "type":"object",
    "properties":{
        "messages":{
            "$ref":"#/definitions/TransferVirtualAccountResponseDTO"
        },
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/TransferVirtualAccountDTO"
            }
        },
        "paging":{
            "$ref":"#/definitions/PagingDto"
        }
    }
}

Nested Schema : data

Type: array

Show Source

• Array of: object TransferVirtualAccountDTO

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

Nested Schema : TransferVirtualAccountResponseDTO

Type: object

Show Source

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

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

Nested Schema : PagingDto

Type: object

Show Source

• totalResults(optional): integer

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

Nested Schema : TransferVirtualAccountDTO

Type: object

Show Source

• branchCode(optional): string
  Branch code of the Virtual Account
• defaultAccCcy(optional): string
  Currency of Virtual Account
• ibanAccNo(optional): string
  International Bank Account Number
• keyId(optional): string
  KeyId of the Virtual Account
• virtualAccountName(optional): string
  Name of the Virtual Account
• virtualAccountNo(optional): string
  Virtual Account Number

{
    "type":"object",
    "properties":{
        "keyId":{
            "type":"string",
            "description":"KeyId of the Virtual Account"
        },
        "virtualAccountNo":{
            "type":"string",
            "description":"Virtual Account Number"
        },
        "virtualAccountName":{
            "type":"string",
            "description":"Name of the Virtual Account"
        },
        "branchCode":{
            "type":"string",
            "description":"Branch code of the Virtual Account"
        },
        "defaultAccCcy":{
            "type":"string",
            "description":"Currency of Virtual Account"
        },
        "ibanAccNo":{
            "type":"string",
            "description":"International Bank Account Number"
        }
    }
}

Nested Schema : codes

Type: array

Show Source

• Array of: object TransferVirtualAccountResponseCode

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

Nested Schema : TransferVirtualAccountResponseCode

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

Back to Top