Skip to main content
POST
Create Payout

Overview

Send money to a Fyatu account holder. The payout is processed instantly - funds are debited from your business wallet and credited to the recipient.

Request Body

Response

Example Usage

Example Response

Fee Calculation

The fee is added on top of the payout amount. Your business wallet is debited for the total (amount + fee).

Error Responses

Payout Limits

Your app may have daily and monthly payout limits configured. If exceeded, the request returns PAYOUT_LIMIT_EXCEEDED.
Payouts are instant and irreversible. Always verify the recipient account before sending.

Best Practices

  1. Verify First: Always call /accounts/{clientId} before creating a payout
  2. Use References: Use unique references for your records and reconciliation
  3. Store Payout ID: Keep the payoutId for support and auditing
  4. Check Balance: Ensure sufficient wallet balance before bulk payouts
  5. Idempotency: Use the same reference to prevent duplicate payouts
For bulk payouts, batch your requests and include unique references for each to track individual payments.

Authorizations

Authorization
string
header
required

JWT access token obtained from /auth/token

Body

application/json
clientId
string
required

Recipient's Fyatu client ID

Example:

"clt_a1b2c3d4e5f6"

amount
number
required

Payout amount in USD

Required range: x >= 1
Example:

100

description
string
required

Description shown to recipient (max 100 chars)

Maximum string length: 100
Example:

"January salary payment"

currency
string
default:USD

Currency code (only USD supported, other values ignored)

reference
string

Your unique reference for tracking

Maximum string length: 100
metadata
object

Custom data to attach

Response

Payout created successfully

success
boolean
Example:

true

status
integer
Example:

201

message
string
data
object
meta
object