Ctrl K
Reserve Account Number for Wallet
POST/api/v1/wallet/reserve-account
Reserves a virtual account number (regular or disposable).
Parameters (for regular)
| Name | Type | Required | Description |
|---|---|---|---|
| wallet_id | string | Yes | Wallet ID. |
| type | string | Yes | "regular". |
| name | string | Yes | Account name. |
| bvn | string | No | BVN. |
| code | string | No | Bank code. |
Parameters (for disposable - additional)
| Name | Type | Required | Description |
|---|---|---|---|
| type | string | Yes | "disposable". |
| expiry | integer | Yes | Expiry in minutes. |
| amount | integer | No | Expected amount (kobo). |
| reference | string | No | Reference. |
| payment_policy | string | No | "ALLOW_ANY", "EXACT_ONLY", "REJECT_UNDER_PAYMENT". |
| error_margin | integer | No | Error margin for amount. |
1
Request Example
(cURL)
curl -X POST "https://api.piggyvest.business/api/v1/wallet/reserve-account" \\-H "Authorization: Bearer YOUR_SECRET_KEY" \\-H "Content-Type: application/json" \\-d '{ "wallet_id": "023f843a-be7e-494a-bc5d-9f49f4cc640f", "type": "regular", "name": "John doe wallet", "bvn": "00000", "code": "003"}'2
Success Response(200)
(JSON)
{ "status": true, "message": "Initiated account reservation", "data": { "reference": "PVB01K8JQC52NQ9R5RJDKG6EZX5ME", "account_details": { "account_number": "2341329231", "account_name": "Test Business/John doe wallet", "bank_name": "FAAS (SANDBOX)" } }}