vrtx Docs
Core APIs
  • Start
  • Onboarding
  • Wallet
  • Payouts
  • Cards
  • Transactions
Closed loop APIsCard Simulator
SDK APIs
  • Coming Soon!
Core APIs
  • Start
  • Onboarding
  • Wallet
  • Payouts
  • Cards
  • Transactions
Closed loop APIsCard Simulator
SDK APIs
  • Coming Soon!
  1. Closed loop APIs
  • Welcome πŸ‘‹
  • Get Started
  • Authentication
  • Responses
  • Pagination
  • Auth
    • Token
      POST
  • Businesses
    • List businesses
      GET
    • Create business
      POST
  • Money Movement
    • Create fund
      POST
    • Create payout
      POST
    • Get payout
      GET
    • Create refund
      POST
    • Create transfer
      POST
    • Create withdrawal
      POST
  • Labels
    • List labels
      GET
    • Create label
      POST
  • Transactions
    • List transactions
      GET
    • Get transaction
      GET
    • List wallet transactions
      GET
  • Wallets
    • List wallets
      GET
    • Create wallet
      POST
    • Lookup wallet
      GET
    • Update wallet
      PATCH
    • Get wallet
      GET
    • Get wallet balance
      GET
    • Remove label
      DELETE
    • Assign label
      PUT
  • Wallet Statements
    • Retrieve wallet statement (preview)
  • Webhooks
    • Register webhook endpoint (preview)
    • List webhook endpoints (preview)
  1. Closed loop APIs

Get Started

The vrtx closed-loop APIs provide a modern, secure, and scalable foundation for embedding financial capabilities directly into your platform. Using these RESTful APIs, developers can create wallets, onboard businesses, move money internally, and process closed-loop transactions β€” all without needing to build or maintain regulated financial infrastructure.
image.png
vrtx Closed-loop Infrastructure
πŸ“Œ
vrtx enables you to go live quickly with controlled, compliant financial operations inside your ecosystem, powering experiences such as user balances, merchant settlements, disbursements, card spend, and in-app payments.

APIs Overview#

vrtx exposes a modular set of APIs that allow you to compose and scale your closed-loop financial system:
Business Management
Wallet Management
Money Movement
Create Fund
Fund a business account within the closed-loop ecosystem to enable payouts, wallet top-ups, and internal transfers.
Create Payout
Move funds from a business operational account to one or more wallets inside the closed-loop ecosystem.
Create Refund
Move funds from one or more wallets back to the business operational account within the closed-loop ecosystem.
Create Transfer
Transfer funds between wallets within the closed-loop ecosystem.
Create Withdrawal
Withdraw funds from a business operational account or a wallet to the clearance wallet, representing settlement or reconciliation outside the closed-loop system.
Labels Management
Wallet Transactions

Requirements#

These are the minimum requirements to work effectively with the vrtx APIs:
1
Get access
Ability to make authenticated API requests
2
Map your flows
Understanding of wallet-based financial flows, limits, and ledgering.
3
Launch!
Get your production access and launch.

Authentication#

vrtx APIs are powered by API Keys, issued per business.
vrtx uses API-key authentication (server-to-server), with optional request signing for high-security environments.
Keys grant scoped access to:
Business management
Wallet operations
Money movement flows
Transactions

Rate Limits#

vrtx enforces rate limits to ensure stability and fairness across all businesses.
If rate limits are exceeded, the API returns:
429 Too Many Requests

Language Support#

All vrtx APIs return responses in English.
Localized descriptions (Arabic, English) for certain fields, such as names, are supported at the business level.

Try It Out#

For a fast start, use any API tool such as Postman, Apidog, or Insomnia.
A full vrtx sandbox collection will be available for import soon.

Changelog#

Track new endpoints, enhancements, patches, and breaking changes soon!

Modified atΒ 2025-11-27 07:04:30
Previous
Welcome πŸ‘‹
Next
Authentication
Built with