Skip to main content
POST
Create dynamic virtual bank account
Creates a dynamic, customer-facing virtual bank account for bank transfer collections.

Notes

  • businessId, amount, reference, merchantCustomerId, and merchantReference are required.
  • merchantCustomerId should match the merchant’s internal user/customer ID.
  • merchantReference should match the merchant’s own order/session/invoice reference.
  • Any extra mapping fields are preserved in metadata and echoed back in the deposit webhook.

Authorizations

x-api-key
string
header
required

Merchant API Key (e.g., nexa-prod-... or nexa-test-...)

Headers

x-business-env
enum<string>
default:prod

Target environment selector (live production vs. simulated sandbox).

Available options:
prod,
test

Body

application/json
businessId
string
required

Unique business ID.

amount
number
required

Expected collection amount.

reference
string
required

Unique reference for the virtual account session.

merchantCustomerId
string
required

ID identifying the end customer.

merchantReference
string
required

Merchant reference of the collection.

validityTime
integer

Session validity limit in minutes (default 4320).

amountValidation
string

Strict or flexible amount check.

sessionId
string
orderId
string
customerName
string
customerEmail
string
customerPhone
string
metadata
object

Response

Virtual account successfully created.