Skip to main content

​
Welcome to Payviox Payout API

The Payviox Payout API allows you to allocate funds to users, manage payout balances, and enable users to withdraw their allocated funds through various payout methods including gift cards, crypto, and more.
Enable Payouts First: Before using the Payout API, ensure payouts are enabled for your business in the dashboard settings.

Authentication

Learn how to authenticate Payout API requests

Create Payout User

Create or add funds to a payout user

Dashboard

Monitor your payout balance and users

Enable Payouts

Configure payout settings in your dashboard

​
Key Concepts

​
Business Payout Balance

Each business has a dedicated payout_balance field that is separate from your main business balance. This balance is used exclusively for payout operations:
  • Funds are debited from payout_balance when you allocate funds to users
  • You must have sufficient payout_balance before creating payout users
  • Balance operations are atomic to prevent race conditions

​
Payout Users

Payout users are identified by their email address and are unique per business:
  • Email-based identification: Each email address represents a unique payout user for your business
  • Balance allocation: Users have an allocated balance amount (stored in cents)
  • Status: Users can be active or inactive
  • Hash: Each user receives a unique SHA256 HMAC hash for secure verification

​
How It Works

1

Fund Your Payout Balance

Add funds to your business payout balance through the dashboard or API
2

Create Payout Users

Use the API to create payout users and allocate funds from your payout balance
3

Users Access Funds

Users can access their allocated funds using the hash provided during creation
4

Withdraw Funds

Users can withdraw funds through various payout methods (gift cards, crypto, etc.)

​
Use Cases

Distribute rewards, commissions, or bonuses to users based on their email address. Perfect for affiliate programs, referral systems, or loyalty rewards.
Process refunds by allocating funds to user payout accounts instead of processing traditional refunds. Users can then choose how to withdraw their funds.
Allocate funds to users who can then purchase gift cards from various providers through the payout system.
Enable users to withdraw their allocated funds as cryptocurrency to their wallets.

​
Base URL

All Payout API requests should be made to: 
https://api.payviox.com

​
Authentication Methods

The Payout API uses two types of authentication:
  1. API Key Authentication (Bearer Token): Used for creating payout users and managing balances
  2. Hash Authentication: Used by payout users to access their funds and make withdrawals
See the Authentication guide for detailed information.

​
Security Features

Atomic Operations

All balance operations are atomic, preventing race conditions and ensuring data consistency

Hash-based Access

Users access their funds using secure SHA256 HMAC hashes

Balance Validation

Automatic validation ensures sufficient balance before allocation

Status Management

Users can be activated or deactivated to control access

​
Getting Started

1

Enable Payouts

Go to your dashboard settings and enable payouts for your business
2

Fund Your Balance

Add funds to your business payout balance
3

Get Your API Key

Retrieve your API key from the Developer section in your dashboard
4

Create Your First User

Use the Create Payout User endpoint to allocate funds to a user

​
Support

Need help with the Payout API?