Simulate (Sandbox)
Path parameters
customerIdstringRequired
The unique identifier of the customer
Header parameters
Api-KeystringRequired
Your secret API key, available in the developer dashboard. Include this header on every request to authenticate your application.
Body
actionstring · enumRequiredPossible values:
The action to perform
virtual_account_idstring · uuidRequired
The unique identifier of the virtual account to issue
Responses
201
Virtual account successfully issued
application/json
idstring · uuidOptional
The unique identifier for the virtual account
statusstring · enumOptionalPossible values:
The current status of the virtual account
destination_tokenstring · enumOptionalPossible values:
The currency to be deposited
destination_networkstring · enumOptionalPossible values:
The blockchain network for the destination
destination_addressstringOptional
The blockchain address where the funds will be sent
developer_fee_percentstringOptionalExample:
Custom developer fee percentage for the Virtual Account
0.5Pattern: ^[0-9]+(\.[0-9]+)?$deposit_instructionsone ofOptional
or
or
400
Bad request - Invalid input or virtual account already active
403
Forbidden - Not available in production environment
500
Internal server error
post
/v0/customers/{customerId}/virtual-account/simulateLast updated
