Quick Start

Get up and running with the VaultsPay API in 5 minutes.

Get your API key

Sign in to the VaultsPay Dashboard, open Developers → API Keys and copy your test secret key (it starts with sk_test_).

Install a client (optional)

Any HTTP client works. For convenience, VaultsPay ships official SDKs:

npm install @vaultspay/node

pip install vaultspay

composer require vaultspay/vaultspay-php

Create your first user

curl -X POST https://sandbox.api.vaultspay.ae/v1/users \
  -H "Authorization: Bearer sk_test_yourApiKeyHere" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "ali@example.com",
    "first_name": "Ali",
    "last_name": "Hassan",
    "mobile": "+971501234567"
  }'

import VaultsPay from '@vaultspay/node'
 
const vp = new VaultsPay(process.env.VAULTSPAY_TEST_KEY)
 
const user = await vp.users.create({
  email: 'ali@example.com',
  first_name: 'Ali',
  last_name: 'Hassan',
  mobile: '+971501234567'
})
 
console.log(user.id)

import vaultspay
 
vaultspay.api_key = os.environ['VAULTSPAY_TEST_KEY']
 
user = vaultspay.User.create(
    email='ali@example.com',
    first_name='Ali',
    last_name='Hassan',
    mobile='+971501234567'
)
 
print(user.id)

<?php
require 'vendor/autoload.php';
 
\VaultsPay\VaultsPay::setApiKey(getenv('VAULTSPAY_TEST_KEY'));
 
$user = \VaultsPay\User::create([
  'email'       => 'ali@example.com',
  'first_name'  => 'Ali',
  'last_name'   => 'Hassan',
  'mobile'      => '+971501234567',
]);
 
echo $user->id;

Open a multi-currency account

curl -X POST https://sandbox.api.vaultspay.ae/v1/accounts \
  -H "Authorization: Bearer sk_test_yourApiKeyHere" \
  -H "Content-Type: application/json" \
  -d '{
    "user_id": "usr_01HX7...",
    "currency": "AED",
    "label": "Primary AED wallet"
  }'

Issue a virtual card

curl -X POST https://sandbox.api.vaultspay.ae/v1/cards \
  -H "Authorization: Bearer sk_test_yourApiKeyHere" \
  -H "Content-Type: application/json" \
  -d '{
    "account_id": "acc_01HX7...",
    "type": "virtual",
    "currency": "AED"
  }'

Listen for webhook events

Configure your endpoint in the dashboard (or via API) to start receiving signed events. See Webhooks → Overview.

What’s next?

Authentication — securing your requests
Users — managing your end users
Payment Cards — virtual and physical cards
Webhooks — real-time events

Environments Making Your First API Call