Jump to

• Request
• Response

Get the sequence of processes happened as part of virtual account closure

get

/service/vaclosurestatus/process

This endpoint is used to get the sequence of process and the status of each process involved in account closure for the given virtual account number.

Request

Supported Media Types

• application/json

Query Parameters

• ibanAccNo(optional): string
  IBAN number for which latest closure status should be fetched
• virtualAccountNo(optional): string
  virtual account number for which latest closure status should be fetched

Back to Top

Response

Supported Media Types

• application/json

201 Response

Returns the list of processes involved in virtual account closure for the given virtual account

Headers

• Location: string

Body ()

Root Schema : VAClosureStatusDetailWrapperDTO

Type: object

Collection of Virtual Account Closure Status log.

Show Source

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

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

Nested Schema : data

Type: array

Show Source

• Array of: object VAClosureStatusDetailDTO

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

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 : VAClosureStatusDetailDTO

Type: object

Show Source

• 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
  Date on which account closure request is initiated
• keyId(optional): string
  ID of Virtual Account Closure Request Status
• nextProcess(optional): string
  Next process in virtual account closure procedure
• referenceNo(optional): string
  Reference number of Virtual Account Closure Request submission
• sourceReferenceNo(optional): string
  Source reference number of Virtual Account Closure Request submission
• VAClosureStatusLogDTO(optional): array VAClosureStatusLogDTO
• virtualAccountName(optional): string
  Name of the virtual account number
• virtualAccountNo(optional): string
  Virtual Account number for which closure is requested

{
    "type":"object",
    "properties":{
        "keyId":{
            "type":"string",
            "description":"ID of Virtual Account Closure Request Status"
        },
        "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"
        },
        "nextProcess":{
            "type":"string",
            "description":"Next process in virtual account closure procedure"
        },
        "closureStatus":{
            "type":"string",
            "description":"Closure status of virtual account number"
        },
        "initDate":{
            "type":"string",
            "description":"Date on which account closure request is initiated"
        },
        "VAClosureStatusLogDTO":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/VAClosureStatusLogDTO"
            }
        }
    }
}

Nested Schema : VAClosureStatusLogDTO

Type: array

Show Source

• Array of: object VAClosureStatusLogDTO

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

Nested Schema : VAClosureStatusLogDTO

Type: object

Show Source

• id(optional): string
  ID of Virtual Account Closure Status Log
• process(optional): string
  Process that executed as part of virtual account closure procedure
• processName(optional): string
  Process that executed as part of virtual account closure procedure
• processStatus(optional): string
  Allowed values for process status is success, failed or waiting
• referenceNo(optional): string
  Reference number of Virtual Account Closure Request
• VAClosureStatusError(optional): array VAClosureStatusError
• virtualAccountNo(optional): string
  Virtual account number for which closure is initiated

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"ID of Virtual Account Closure Status Log"
        },
        "referenceNo":{
            "type":"string",
            "description":"Reference number of Virtual Account Closure Request"
        },
        "virtualAccountNo":{
            "type":"string",
            "description":"Virtual account number for which closure is initiated"
        },
        "process":{
            "type":"string",
            "description":"Process that executed as part of virtual account closure procedure"
        },
        "processName":{
            "type":"string",
            "description":"Process that executed as part of virtual account closure procedure"
        },
        "processStatus":{
            "type":"string",
            "description":"Allowed values for process status is success, failed or waiting"
        },
        "VAClosureStatusError":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/VAClosureStatusErrorDTO"
            }
        }
    }
}

Nested Schema : VAClosureStatusError

Type: array

Show Source

• Array of: object VAClosureStatusErrorDTO

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

Nested Schema : VAClosureStatusErrorDTO

Type: object

Show Source

• addtionalDescription(optional): string
  Additional description for the error
• errorCode(optional): string
  Error code
• errorDesc(optional): string
  Error Description

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Error code"
        },
        "errorDesc":{
            "type":"string",
            "description":"Error Description"
        },
        "addtionalDescription":{
            "type":"string",
            "description":"Additional description for the error"
        }
    }
}

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