Jump to

• Request
• Response

Creates a new transaction request for Virtual Account Closure

post

/service/accountclosure

This endpoint is used to initiate a new closure request for a set of Virtual Accounts.

Request

Supported Media Types

• application/json

Header Parameters

• sourceCode: string
  Source from which request is initiated

Body ()

Request Body that contains data required for initiating a new Virtual Account Closure request

Root Schema : VAClosureRequestDTO

Type: object

Show Source

• operationType(optional): string
  operation type
• resourceId(optional): string
  resource id
• resourceName(optional): string
  resource name
• sourceReferenceNo(optional): string
  Source Reference number of Virtual Account Closure Request
• TransferDetailsDTO(optional): array TransferDetailsDTO

{
    "type":"object",
    "properties":{
        "resourceId":{
            "description":"resource id",
            "type":"string"
        },
        "resourceName":{
            "description":"resource name",
            "type":"string"
        },
        "operationType":{
            "description":"operation type",
            "type":"string"
        },
        "sourceReferenceNo":{
            "type":"string",
            "description":"Source Reference number of Virtual Account Closure Request"
        },
        "TransferDetailsDTO":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/TransferDetailsDTO"
            }
        }
    }
}

Nested Schema : TransferDetailsDTO

Type: array

Show Source

• Array of: object TransferDetailsDTO

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

Nested Schema : TransferDetailsDTO

Type: object

Show Source

• transferInVirAccNo(optional): string
  Virtual Account number from where the funds will be transferred
• transferOutVirAccNo(optional): string
  Virtual Account number to which the funds will be transferred
• virtualAccountNumber: string
  Virtual Account number for which closure is requested

{
    "type":"object",
    "properties":{
        "virtualAccountNumber":{
            "type":"string",
            "description":"Virtual Account number for which closure is requested"
        },
        "transferInVirAccNo":{
            "type":"string",
            "description":"Virtual Account number from where the funds will be transferred"
        },
        "transferOutVirAccNo":{
            "type":"string",
            "description":"Virtual Account number to which the funds will be transferred"
        }
    },
    "required":[
        "virtualAccountNumber"
    ]
}

Back to Top

Response

Supported Media Types

• application/json

201 Response

Returns message of success or failure

Headers

• Location: string
  URL of newly created Virtual Account Closure Request

Body ()

Root Schema : ClosureDetailsServiceDTOWrapper

Type: object

Show Source

• data(optional): object ClosureRequestDetailsServiceDTO
• messages(optional): object ClosureReqDetailsResponseDto

{
    "type":"object",
    "properties":{
        "messages":{
            "$ref":"#/definitions/ClosureReqDetailsResponseDto"
        },
        "data":{
            "$ref":"#/definitions/ClosureRequestDetailsServiceDTO"
        }
    }
}

Nested Schema : ClosureRequestDetailsServiceDTO

Type: object

Show Source

• AccountDetailDTO(optional): array AccountDetailDTO
• authStatus(optional): string
  Authorization status of Virtual Account Closure Request
• checkerDateStamp(optional): string(date)
  Checker Date time stamp of Virtual Account Closure Request
• CheckerId(optional): string
  Checker of Virtual Account Closure Request
• makerDateStamp(optional): string(date)
  Maker Date time stamp of Virtual Account Closure Request
• makerId(optional): string
  Maker of Virtual Account Closure Request
• obvamRequestRefNo(optional): string
  Request Reference Number
• sourceCode(optional): string
  Source Code
• sourceReferenceNo(optional): string
  External Reference Number

{
    "type":"object",
    "properties":{
        "sourceReferenceNo":{
            "type":"string",
            "description":"External Reference Number"
        },
        "obvamRequestRefNo":{
            "type":"string",
            "description":"Request Reference Number"
        },
        "sourceCode":{
            "type":"string",
            "description":"Source Code"
        },
        "makerId":{
            "type":"string",
            "description":"Maker of Virtual Account Closure Request"
        },
        "CheckerId":{
            "type":"string",
            "description":"Checker of Virtual Account Closure Request"
        },
        "makerDateStamp":{
            "type":"string",
            "format":"date",
            "description":"Maker Date time stamp of Virtual Account Closure Request"
        },
        "checkerDateStamp":{
            "type":"string",
            "format":"date",
            "description":"Checker Date time stamp of Virtual Account Closure Request"
        },
        "authStatus":{
            "type":"string",
            "description":"Authorization status of Virtual Account Closure Request"
        },
        "AccountDetailDTO":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/AccountDetailDTO"
            }
        }
    }
}

Nested Schema : ClosureReqDetailsResponseDto

Type: object

Show Source

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

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

Nested Schema : AccountDetailDTO

Type: array

Show Source

• Array of: object AccountDetailDTO

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

Nested Schema : AccountDetailDTO

Type: object

Show Source

• branchCode(optional): string
  Branch Code of Virtual Account for which Closure was initiated
• defaultAccCcy(optional): string
  Currency of Virtual Account for which Closure was initiated
• realCustomerNo(optional): string
  Real Customer Number to whom the Virtual Account Number, for which Closure was initiated, belongs
• transferInVirAccNo(optional): string
  Virtual Account to which the funds will be transferred
• transferOutVirAccNo(optional): string
  Virtual Account from which the funds will be transferred
• virtualAccountName(optional): string
  Virtual Account Name for which Closure was initiated
• virtualAccountNo(optional): string
  Virtual Account Number for which Closure was initiated

{
    "type":"object",
    "properties":{
        "realCustomerNo":{
            "type":"string",
            "description":"Real Customer Number to whom the Virtual Account Number, for which Closure was initiated, belongs"
        },
        "virtualAccountNo":{
            "type":"string",
            "description":"Virtual Account Number for which Closure was initiated"
        },
        "virtualAccountName":{
            "type":"string",
            "description":"Virtual Account Name for which Closure was initiated"
        },
        "defaultAccCcy":{
            "type":"string",
            "description":"Currency of Virtual Account for which Closure was initiated"
        },
        "branchCode":{
            "type":"string",
            "description":"Branch Code of Virtual Account for which Closure was initiated"
        },
        "transferInVirAccNo":{
            "type":"string",
            "description":"Virtual Account to which the funds will be transferred"
        },
        "transferOutVirAccNo":{
            "type":"string",
            "description":"Virtual Account from which the funds will be transferred"
        }
    }
}

Nested Schema : codes

Type: array

Show Source

• Array of: object ClosureReqDetailsResponseCode

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

Nested Schema : ClosureReqDetailsResponseCode

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