VIRTUAL_ACCOUNTS feature and virtual-accounts:write. In live mode the bank must also have approved your business and recorded your settlement account.
Create one
name_statusstartspendingwhile the bank’s provider names the number, then becomesconfirmed(orfailed). You’ll getva.name.confirmedorva.name.failed.settlement_accountis the account at the bank the payments go on to, ornullwhen it follows your business’s default, which the bank records.
Rename it, or name a number
PATCH /v1/virtual-accounts/{accountId} changes the name payers see, and/or the label. Send a person’s name (first_name, last_name, optional middle_name) or free text (account_name), not both.
- A number from the provider’s pool is renamed there first:
202,name_statuspending, and a second rename meanwhile is409(code25). - A number from one of your number patterns is named at once:
200.
PUT /v1/virtual-accounts/numbers/{accountNumber} names a number under one of your patterns, even before its first payment. If nobody holds it yet, it creates the account (201).
Payments and settlements
GET /v1/virtual-accounts/{accountId}/paymentslists the payments into it.GET /v1/virtual-accounts/{accountId}/settlementslists each payment passed on to your settlement account:queued,settledorfailed.GET /v1/collection-settlementslists them across every collection account.
va.payment.success when credited, and va.settlement.completed when passed on to your account at the bank.