- Virtual Account
- Delete
Virtual Account
Delete
Delete existing temporary or permanent virtual accounts.
Information
| Method | Path | Format | Authentication |
|---|---|---|---|
| DELETE | /api/v1.0/virtual-accounts/{account_id}/{virtual_account_id} | json | OAuth 2.0 with Access Token |
Request Details
Headers Structure
| Field | Value | Type | Mandatory | Length | Description | Example |
|---|---|---|---|---|---|---|
| X-PARTNER-ID | api_key | Alphanumeric | Mandatory | API key obtained from the merchant dashboard. | b3ed7d4b-a96c-6c08-b3c7-12c3124242d9 | |
| Accept | application/json | Alphabetic | Mandatory | Specifies JSON as the expected response format. | application/json | |
| Authorization | Bearer {bearerToken} | Alphanumeric | Mandatory | Bearer token obtained from the get access token endpoint. | Bearer eyJ0eXAiOiJKV1{…} |
Response Details
Response Structure
| Field | Type | Mandatory | Length | Description | Example |
|---|---|---|---|---|---|
| status | Numeric | Mandatory | 3 | HTTP Status Code | 200 |
| success | Boolean | Mandatory | 1 | Indicates whether the request was successful (2xx is true, 4xx-500 is false) | true |
| data | Object | Conditional | - | Contains the response data | - |
| > message | String | Mandatory | - | A message indicating the result of the operation | “Virtual Account delete successfully” |
Response Example
Success: Here’s an example of a successful response.
{
"status": 200,
"success": true,
"data": {
"message": "Virtual Account delete successfully"
}
}Error: This is an example of an unsuccessful request.
{
"status": 403,
"success": false,
"error": {
"code": 403,
"message": "This Virtual Account has have transactions"
}
}