Skip to main content
POST
Simulate virtual account deposit

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-MultiTenantKey
string

Required when using a Platform API token. The tenant key identifying which business to operate on.

Path Parameters

userId
string<uuid>
required

The unique identifier for the user

Example:

"c06f3427-3bbe-4d70-9a54-28acda267e48"

virtualAccountId
string<uuid>
required

The unique identifier for the virtual account

Example:

"c06f3427-3bbe-4d70-9a54-28acda267e48"

Body

application/json

Simulate virtual account deposit payload

amount
object
required
reference
string<uuid>
required
Example:

"8ef9a712-cdae-4110-b1ea-9ba95abbee6e"

description
string
required
Example:

"Payroll 10/10"

Response

Successful operation