Jump to

• Request
• Response

Get all the Virtual account closure request status records

get

/service/vaclosurestatus

This endpoint is used to get all the virtual accounts for which closure request is initiated

Request

Supported Media Types

• application/json

Query Parameters

• closureStatus(optional): string
• customerID(optional): string
• fromDate(optional): string
  Pattern: [0-9]{4}[-][0-9]{2}[-][0-9]{2}
• ibanAccNo(optional): string
• limit(optional): integer
  limit is maximum no of records to be fetched
• offset(optional): integer
  offset is starting no of records to be fetched
• sourceReferenceNo(optional): string
• toDate(optional): string
  Pattern: [0-9]{4}[-][0-9]{2}[-][0-9]{2}
• virtualAccountName(optional): string
• virtualAccountNo(optional): string

Back to Top

Response

Supported Media Types

• application/json

201 Response

Returns virtual account closure request status records

Headers

• Location: string

Body ()

Root Schema : VAClosureStatusServiceCollection

Type: object

Collection of Virtual Account Closure Status records.

Show Source

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

{
    "description":"Collection of Virtual Account Closure Status records.",
    "type":"object",
    "properties":{
        "messages":{
            "$ref":"#/definitions/VAClosureStatusServiceResponseDTO"
        },
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/VAClosureStatusServiceDTO"
            }
        },
        "paging":{
            "$ref":"#/definitions/PagingDto"
        }
    }
}

Nested Schema : data

Type: array

Show Source

• Array of: object VAClosureStatusServiceDTO

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

Nested Schema : VAClosureStatusServiceResponseDTO

Type: object

Show Source

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

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

Nested Schema : PagingDto

Type: object

Show Source

• totalResults(optional): integer

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

Nested Schema : VAClosureStatusServiceDTO

Type: object

Show Source

• branchName(optional): string
  Minimum Value: 0

  Maximum Value: 105

  Name of the Branch for Virtual Account
• closureStatus(optional): string
  Closure status of virtual account number
• customerID(optional): string
  Customer ID of the virtual account number
• ibanAccNo(optional): string
  International Bank Account Number
• initDate(optional): string
  If any process fails during virtual account closure, then reason for failure will be captured
• referenceNo(optional): string
  Reference number of Virtual Account Closure Request submission
• sourceReferenceNo(optional): string
  Source reference number of Virtual Account Closure Request submission
• virtualAccountName(optional): string
  Name of the virtual account number
• virtualAccountNo(optional): string
  Virtual Account number for which closure is requested

{
    "type":"object",
    "properties":{
        "referenceNo":{
            "type":"string",
            "description":"Reference number of Virtual Account Closure Request submission"
        },
        "sourceReferenceNo":{
            "type":"string",
            "description":"Source reference number of Virtual Account Closure Request submission"
        },
        "customerID":{
            "type":"string",
            "description":"Customer ID of the virtual account number"
        },
        "virtualAccountNo":{
            "type":"string",
            "description":"Virtual Account number for which closure is requested"
        },
        "virtualAccountName":{
            "type":"string",
            "description":"Name of the virtual account number"
        },
        "ibanAccNo":{
            "type":"string",
            "description":"International Bank Account Number"
        },
        "closureStatus":{
            "type":"string",
            "description":"Closure status of virtual account number"
        },
        "initDate":{
            "type":"string",
            "description":"If any process fails during virtual account closure, then reason for failure will be captured"
        },
        "branchName":{
            "type":"string",
            "description":"Name of the Branch for Virtual Account",
            "minimum":0,
            "maximum":105
        }
    }
}

Nested Schema : codes

Type: array

Show Source

• Array of: object VAClosureStatusServiceResponseCode

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

Nested Schema : VAClosureStatusServiceResponseCode

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