Create a virtual account
create_virtual_accountCreate a permanent customer account or a single-use NUBAN that routes incoming transfers into your balance, with dedicated accounts tied to a customer and dynamic accounts tied to one payment.
Instructions
Create a virtual account.
Create a virtual account (a real NUBAN that routes into your balance).
Dedicated (type: dedicated, needs customer_id): a permanent account for one customer. Every transfer into it creates a succeeded payment with source: dedicated_virtual_account, whatever the amount. Close it when you no longer want to receive money through it.
Dynamic (type: dynamic, needs amount and reference): a single-use account for one exact amount. This is the same as creating a payment with POST /api/v1/payments; the response is the account, and the payment id is in payment.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| type | Yes | dedicated: permanent account for a customer. dynamic: single-use account bound to one payment. | |
| amount | No | Dynamic only: amount in kobo | |
| currency | No | Dynamic only | |
| metadata | No | ||
| reference | No | Dynamic only: your unique payment reference | |
| expires_at | No | Dynamic only | |
| customer_id | No | Customer id (cus_…). Required for dedicated accounts. | |
| idempotency_key | No | Optional. A unique key for this request; retrying with the same key returns the original result instead of acting twice. One is generated if omitted. |