Skip to main content
POST
/
virtual-account
/
create
Create a fiat virtual account
curl --request POST \
  --url https://ramp-sandbox.hexarails.ai/virtual-account/create \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "customerId": "12345",
  "currency": "AUD"
}
'
{
  "status": "SUCCESS",
  "data": {
    "id": "va_123",
    "customerId": "12345",
    "customerName": "John Doe",
    "currency": "AUD",
    "accountNumber": "12345678",
    "bicSwift": "123-456",
    "payId": "john.doe@example.com",
    "iban": "IBAN1234567890",
    "createTime": "2024-01-01T00:00:00Z",
    "status": "VERIFIED",
    "bankName": "Example Bank",
    "bankAddress": "123 Example Street, London, UK"
  }
}

Authorizations

X-API-Key
string
header
required

Body

application/json
customerId
string
required

ID of the customer

Example:

"12345"

currency
enum<string>
required

Currency for the virtual account

Available options:
GBP,
EUR,
AUD
Example:

"AUD"

whitelist
object

Whitelist source account for AUD VA. When provided, this account will be pre-registered as a whitelisted sender for the AUD virtual account automatically after VA creation.

Response

Get VA detail successful

status
enum<string>
required

Success response status

Available options:
SUCCESS
Example:

"SUCCESS"

data
object
required

Response data