1. Vrtx APIs
Vrtx Docs
  • Welcome 👋
  • Get Started
  • Auth
    • Token
      POST
  • Payouts
    • Create payout
      POST
    • Get payout status
      GET
    • Create bulk payout
      POST
    • Get bulk payout status
      GET
    • Get batch report
      GET
  • Transactions
    • Business Accounts
      • Get business account balance
      • List business transactions
      • Get transaction details by reference
  • Whitelist
    • Add whitelist entries
      POST
    • Get whitelist entries
      GET
    • Delete whitelist entries
      DELETE
Vrtx APIs
Vrtx Closed loop
Vrtx APIs
Vrtx Closed loop
  1. Vrtx APIs

Get Started

The Vrtx Client APIs provide secure REST APIs that allow businesses to integrate directly with Vrtx external services.
These APIs are intended for server-to-server integrations and are used to authenticate requests, initiate payouts, retrieve transaction data, manage business configurations, and maintain whitelist entries.
📌
The APIs documented here are the external APIs exposed to clients. SDK-related content, implementation guides, onboarding flows, and developer-facing product material should can be accessed from Vrtx Developer Portal.

APIs Overview#

Vrtx exposes the following external API modules to clients:
ModuleDescription
AuthGenerate access tokens used to authenticate API requests.
PayoutsCreate single or bulk payouts and retrieve payout processing statuses.
TransactionsRetrieve business account balances, business transactions, and transaction details.
Business ConfigurationsRetrieve the configuration assigned to a business.
WhitelistAdd, retrieve, and delete whitelist entries.

Auth#

Use the Auth API to generate an access token for authenticated API requests.

Available API#

APIMethodDescription
TokenPOSTGenerate an access token to authenticate requests to Vrtx APIs.

Payouts#

Use the Payouts APIs to send funds to beneficiaries and track payout processing statuses.

Available APIs#

APIMethodDescription
Create PayoutPOSTCreate a single payout request.
Get Payout StatusGETRetrieve the status of a payout request.
Create Bulk PayoutPOSTCreate a batch payout request containing multiple payout instructions.
Get Bulk Payout StatusGETRetrieve the status of a bulk payout request.
Get Batch ReportGETRetrieve the processing report for a payout batch.

Transactions#

Use the Transactions APIs to retrieve business account balances and transaction records.

Available APIs#

APIMethodDescription
Get Business Account BalanceGETRetrieve the available balance for a business account.
Get Transaction Details by ReferenceGETRetrieve transaction details using a transaction reference.
List Business TransactionsGETRetrieve a list of transactions for a business account.

Business Configurations#

Use the Business Configurations API to retrieve the configuration assigned to a business.

Available API#

APIMethodDescription
Get Business ConfigurationsGETRetrieve business-level configuration values used by the client integration.

Whitelist#

Use the Whitelist APIs to manage whitelist entries for a business.

Available APIs#

APIMethodDescription
Add Whitelist EntriesPOSTAdd one or more whitelist entries.
Get Whitelist EntriesGETRetrieve existing whitelist entries.
Delete Whitelist EntriesDELETEDelete existing whitelist entries.

Requirements#

To use the Vrtx Client APIs, clients must have:
1
API Access
Access to the Vrtx API environment and the required client credentials.
2
Authentication
A valid access token generated through the Auth API.
3
Configured Business Account
An active business account configured by Vrtx.
4
Approved Use Case
The required API module enabled based on the client’s approved integration scope.

Authentication#

All API requests must be authenticated using a valid access token generated through the Auth API.
The access token should be included in API requests according to the authentication requirements defined in the API reference.
🔐
Access tokens should only be generated and stored on secure backend systems.
Do not expose API credentials or access tokens in frontend applications, mobile apps, or client-side code.

Response Format#

Vrtx APIs return structured JSON responses.
Successful responses return the requested resource or operation status. Failed responses return an error response containing the relevant error information.

Example Error Response#

{
    "error_code": "INVALID_INPUT",
    "error_message": "The inputs does not match the requirements.",
    "details": [
        {
            "field_name": "mobile_number",
            "description": "It should start with +966.",
            "code": "mobile_number_invalid"
        }
    ],
    "status_code": 400
}

Rate Limits#

Vrtx may apply rate limits to protect platform stability and ensure fair usage across clients.
When a request exceeds the allowed limit, the API may return:
{
    "error_code": "TOO_MANY_REQUESTS",
    "error_message": "You have sent too mnay requests.",
    "status_code": 429
}

Try It Out#

To start using the Vrtx Client APIs:
1.
Generate an access token using the Auth API.
2.
Use the token to authenticate API requests.
3.
Call the required API module based on your use case:
Use Payouts for single or bulk payout processing.
Use Transactions for balances and transaction history.
Use Business Configurations for business setup values.
Use Whitelist for whitelist management.

Changelog#

Follow updates for:
New endpoints
Security enhancements
Payout processing updates
Transaction reporting updates
Breaking changes
Deprecations
Modified at 2026-05-31 10:24:03
Previous
Welcome 👋
Next
Token
Built with