Virtual Account Management
Fetch Virtual Accounts
Endpoint
GET {{baseUrl}}
/business/virtual-account
Description
This endpoint allows you to fetch all virtual accounts
Request
Headers
Content-Type: application/json
Authorization: Bearer {your_api_token}
Fetch Virtual Account
Endpoint
POST {{baseUrl}}/business/virtual-account/show/{{customerID}}
Description
This endpoint allows you to fetch a particular virtual account, effectively marking it as inactive and preventing any further transactions.
Request
Headers
Content-Type: application/json
Authorization: Bearer {your_api_token}
{"status":"failed","status_code":400,"message":"Request failed","data":{"account_id":"2332e12b-4568-41d7-aefa-00560c5715d9","currency":"MXN","account_info":{"country":"MEX","currency":"MXN","account_number":"646010319801292000","bank_code":"646","bank_name":"Unknown Bank"},"extra_data":null,"request_object":{"address":{"city":"LUGBE","state":"FCT","number":"30","street":"ABC ORJIAKO, TRADEMORE ESTATE","country":"Nigeria","zipcode":"900901"},"country":"MEX","currency":"MXN","beneficiary":{"name":"Emmanuel","type":"INDIVIDUAL","document":{"id":"A10600086","type":"PASSPORT"},"lastname":"Towoju"}},"account_number":"646010319801292000"}}
GET /api/v1/business/virtual-account/show/e7ee01e9-adb8-4431-903d-b89d0872320d HTTP/1.1
Host: smtp.yativo.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
Bad Request
{
"status": "failed",
"status_code": 400,
"message": "Request failed",
"data": {
"account_id": "2332e12b-4568-41d7-aefa-00560c5715d9",
"currency": "MXN",
"account_info": {
"country": "MEX",
"currency": "MXN",
"account_number": "646010319801292000",
"bank_code": "646",
"bank_name": "Unknown Bank"
},
"extra_data": null,
"request_object": {
"address": {
"city": "LUGBE",
"state": "FCT",
"number": "30",
"street": "ABC ORJIAKO, TRADEMORE ESTATE",
"country": "Nigeria",
"zipcode": "900901"
},
"country": "MEX",
"currency": "MXN",
"beneficiary": {
"name": "Emmanuel",
"type": "INDIVIDUAL",
"document": {
"id": "A10600086",
"type": "PASSPORT"
},
"lastname": "Towoju"
}
},
"account_number": "646010319801292000"
}
}
Delete Virtual Account
Endpoint
POST {{baseUrl}}/business/virtual-account/delete-virtual-account/{{customerID}}
Description
This endpoint allows you to delete a virtual account, effectively marking it as inactive and preventing any further transactions.
Request
Headers
Content-Type: application/json
Authorization: Bearer {your_api_token}
Path Parameters
customer_id
string
Yes
Unique identifier of the virtual account
Example Request
POST {{baseUrl}}/business/virtual-account/delete-virtual-account/{{customerID}}
Authorization: Bearer your_api_token
Content-Type: application/json
Response
Success (200)
message
string
Success message
customer_id
string
Unique identifier of the account
status
string
New status of the account ("archived")
Example Response
{
"message": "Virtual account deleted successfully."
}
Last updated