Create Payout
curl --request POST \
--url https://api.fyatu.com/api/v3/payouts \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"clientId": "clt_a1b2c3d4e5f6",
"amount": 100,
"currency": "USD",
"description": "January 2026 Salary",
"reference": "PAY-20260108-001"
}
'import requests
url = "https://api.fyatu.com/api/v3/payouts"
payload = {
"clientId": "clt_a1b2c3d4e5f6",
"amount": 100,
"currency": "USD",
"description": "January 2026 Salary",
"reference": "PAY-20260108-001"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
clientId: 'clt_a1b2c3d4e5f6',
amount: 100,
currency: 'USD',
description: 'January 2026 Salary',
reference: 'PAY-20260108-001'
})
};
fetch('https://api.fyatu.com/api/v3/payouts', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.fyatu.com/api/v3/payouts",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'clientId' => 'clt_a1b2c3d4e5f6',
'amount' => 100,
'currency' => 'USD',
'description' => 'January 2026 Salary',
'reference' => 'PAY-20260108-001'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.fyatu.com/api/v3/payouts"
payload := strings.NewReader("{\n \"clientId\": \"clt_a1b2c3d4e5f6\",\n \"amount\": 100,\n \"currency\": \"USD\",\n \"description\": \"January 2026 Salary\",\n \"reference\": \"PAY-20260108-001\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.fyatu.com/api/v3/payouts")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"clientId\": \"clt_a1b2c3d4e5f6\",\n \"amount\": 100,\n \"currency\": \"USD\",\n \"description\": \"January 2026 Salary\",\n \"reference\": \"PAY-20260108-001\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.fyatu.com/api/v3/payouts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"clientId\": \"clt_a1b2c3d4e5f6\",\n \"amount\": 100,\n \"currency\": \"USD\",\n \"description\": \"January 2026 Salary\",\n \"reference\": \"PAY-20260108-001\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"status": 201,
"message": "<string>",
"data": {
"payoutId": "<string>",
"reference": "<string>",
"recipient": {
"clientId": "<string>",
"name": "<string>"
},
"amount": 123,
"fee": 123,
"totalDebited": 123,
"currency": "<string>",
"status": "PENDING",
"createdAt": "2023-11-07T05:31:56Z"
},
"meta": {
"requestId": "req_abc123def456",
"timestamp": "2023-11-07T05:31:56Z"
}
}{
"success": false,
"status": 400,
"message": "Validation failed",
"error": {
"code": "VALIDATION_ERROR",
"details": [
{
"field": "currency",
"message": "Currency is required"
}
]
},
"meta": {
"requestId": "req_abc123",
"timestamp": "2026-01-05T10:30:00+00:00"
}
}{
"success": false,
"status": 401,
"message": "Unable to identify business",
"error": {
"code": "AUTH_TOKEN_INVALID"
},
"meta": {
"requestId": "req_abc123",
"timestamp": "2026-01-05T10:30:00+00:00"
}
}{
"success": false,
"status": 401,
"message": "Invalid credentials",
"error": {
"code": "AUTH_INVALID_CREDENTIALS",
"details": [
{
"field": "appId",
"message": "AppId is required"
}
]
},
"meta": {
"requestId": "req_abc123def456",
"timestamp": "2023-11-07T05:31:56Z"
}
}{
"success": false,
"status": 404,
"message": "Wallet not found",
"error": {
"code": "RESOURCE_NOT_FOUND"
},
"meta": {
"requestId": "req_abc123",
"timestamp": "2026-01-05T10:30:00+00:00"
}
}Payouts
Create Payout
Create an instant payout to a Fyatu user. Specify amount, recipient, and reference for reconciliation. POST /payouts.
POST
/
payouts
Create Payout
curl --request POST \
--url https://api.fyatu.com/api/v3/payouts \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"clientId": "clt_a1b2c3d4e5f6",
"amount": 100,
"currency": "USD",
"description": "January 2026 Salary",
"reference": "PAY-20260108-001"
}
'import requests
url = "https://api.fyatu.com/api/v3/payouts"
payload = {
"clientId": "clt_a1b2c3d4e5f6",
"amount": 100,
"currency": "USD",
"description": "January 2026 Salary",
"reference": "PAY-20260108-001"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
clientId: 'clt_a1b2c3d4e5f6',
amount: 100,
currency: 'USD',
description: 'January 2026 Salary',
reference: 'PAY-20260108-001'
})
};
fetch('https://api.fyatu.com/api/v3/payouts', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.fyatu.com/api/v3/payouts",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'clientId' => 'clt_a1b2c3d4e5f6',
'amount' => 100,
'currency' => 'USD',
'description' => 'January 2026 Salary',
'reference' => 'PAY-20260108-001'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.fyatu.com/api/v3/payouts"
payload := strings.NewReader("{\n \"clientId\": \"clt_a1b2c3d4e5f6\",\n \"amount\": 100,\n \"currency\": \"USD\",\n \"description\": \"January 2026 Salary\",\n \"reference\": \"PAY-20260108-001\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.fyatu.com/api/v3/payouts")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"clientId\": \"clt_a1b2c3d4e5f6\",\n \"amount\": 100,\n \"currency\": \"USD\",\n \"description\": \"January 2026 Salary\",\n \"reference\": \"PAY-20260108-001\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.fyatu.com/api/v3/payouts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"clientId\": \"clt_a1b2c3d4e5f6\",\n \"amount\": 100,\n \"currency\": \"USD\",\n \"description\": \"January 2026 Salary\",\n \"reference\": \"PAY-20260108-001\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"status": 201,
"message": "<string>",
"data": {
"payoutId": "<string>",
"reference": "<string>",
"recipient": {
"clientId": "<string>",
"name": "<string>"
},
"amount": 123,
"fee": 123,
"totalDebited": 123,
"currency": "<string>",
"status": "PENDING",
"createdAt": "2023-11-07T05:31:56Z"
},
"meta": {
"requestId": "req_abc123def456",
"timestamp": "2023-11-07T05:31:56Z"
}
}{
"success": false,
"status": 400,
"message": "Validation failed",
"error": {
"code": "VALIDATION_ERROR",
"details": [
{
"field": "currency",
"message": "Currency is required"
}
]
},
"meta": {
"requestId": "req_abc123",
"timestamp": "2026-01-05T10:30:00+00:00"
}
}{
"success": false,
"status": 401,
"message": "Unable to identify business",
"error": {
"code": "AUTH_TOKEN_INVALID"
},
"meta": {
"requestId": "req_abc123",
"timestamp": "2026-01-05T10:30:00+00:00"
}
}{
"success": false,
"status": 401,
"message": "Invalid credentials",
"error": {
"code": "AUTH_INVALID_CREDENTIALS",
"details": [
{
"field": "appId",
"message": "AppId is required"
}
]
},
"meta": {
"requestId": "req_abc123def456",
"timestamp": "2023-11-07T05:31:56Z"
}
}{
"success": false,
"status": 404,
"message": "Wallet not found",
"error": {
"code": "RESOURCE_NOT_FOUND"
},
"meta": {
"requestId": "req_abc123",
"timestamp": "2026-01-05T10:30:00+00:00"
}
}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
| Field | Type | Required | Description |
|---|---|---|---|
clientId | string | Yes | Recipient’s Fyatu client ID |
amount | number | Yes | Payout amount in USD |
currency | string | No | Currency code (default: USD). Only USD supported, other values are ignored |
description | string | Yes | Description shown to recipient (max 100 chars) |
reference | string | No | Your unique reference for tracking (max 100 chars) |
metadata | object | No | Custom data to attach |
Response
| Field | Type | Description |
|---|---|---|
payoutId | string | Unique payout identifier |
reference | string | Your reference (if provided) |
recipient | object | Recipient information |
amount | number | Payout amount |
fee | number | Processing fee |
totalDebited | number | Total debited (amount + fee) |
currency | string | Currency code |
status | string | COMPLETED |
createdAt | string | Payout timestamp |
Example Usage
<?php
$clientId = 'clt_a1b2c3d4e5f6';
$amount = 100.00;
// Step 1: Verify the account first
$verifyResponse = file_get_contents(
"https://api.fyatu.com/api/v3/accounts/{$clientId}",
false,
stream_context_create([
'http' => [
'method' => 'GET',
'header' => 'Authorization: Bearer ' . $accessToken
]
])
);
$account = json_decode($verifyResponse, true);
if (!$account['success'] || !$account['data']['canReceive']) {
die('Cannot send to this account');
}
// Step 2: Create the payout
$response = file_get_contents(
'https://api.fyatu.com/api/v3/payouts',
false,
stream_context_create([
'http' => [
'method' => 'POST',
'header' => [
'Content-Type: application/json',
'Authorization: Bearer ' . $accessToken
],
'content' => json_encode([
'clientId' => $clientId,
'amount' => $amount,
'description' => 'Staff Payment',
'reference' => 'PAY-0001',
'metadata' => [
'reference' => 'PAYROLL-001'
]
])
]
])
);
$result = json_decode($response, true);
if ($result['success']) {
echo "Payout successful!\n";
echo "Payout ID: {$result['data']['payoutId']}\n";
echo "Recipient: {$result['data']['recipient']['name']}\n";
echo "Amount: {$result['data']['amount']} USD\n";
echo "Fee: {$result['data']['fee']} USD\n";
echo "Total Debited: {$result['data']['totalDebited']} USD\n";
} else {
echo "Payout failed: {$result['message']}\n";
}
const clientId = 'clt_a1b2c3d4e5f6';
const amount = 100.00;
// Step 1: Verify the account first
const verifyResponse = await fetch(
`https://api.fyatu.com/api/v3/accounts/${clientId}`,
{
headers: {
'Authorization': `Bearer ${accessToken}`
}
}
);
const account = await verifyResponse.json();
if (!account.success || !account.data.canReceive) {
throw new Error('Cannot send to this account');
}
// Step 2: Create the payout
const response = await fetch('https://api.fyatu.com/api/v3/payouts', {
method: 'POST',
headers: {
'Content-Type': 'application/json',
'Authorization': `Bearer ${accessToken}`
},
body: JSON.stringify({
clientId,
amount,
description: 'Staff Payment',
reference: 'PAY-0001',
metadata: {
reference: 'PAYROLL-001'
}
})
});
const result = await response.json();
if (result.success) {
console.log('Payout successful!');
console.log(`Payout ID: ${result.data.payoutId}`);
console.log(`Recipient: ${result.data.recipient.name}`);
console.log(`Amount: ${result.data.amount} USD`);
console.log(`Fee: ${result.data.fee} USD`);
console.log(`Total Debited: ${result.data.totalDebited} USD`);
} else {
console.log(`Payout failed: ${result.message}`);
}
Example Response
{
"success": true,
"status": 201,
"message": "Payout processed successfully",
"data": {
"payoutId": "pay_a1b2c3d4e5f6",
"reference": "PAY-0001",
"recipient": {
"clientId": "clt_a1b2c3d4e5f6",
"name": "Alice Example"
},
"amount": 100.00,
"fee": 0.50,
"totalDebited": 100.50,
"currency": "USD",
"status": "COMPLETED",
"createdAt": "2026-01-08T10:30:00+00:00"
},
"meta": {
"requestId": "req_payout123",
"timestamp": "2026-01-08T10:30:00+00:00"
}
}
Fee Calculation
| Payout Amount | $100.00 |
|---|---|
| Payout Fee | +$0.50 |
| Total Debited | $100.50 |
Error Responses
| Error Code | HTTP | Description |
|---|---|---|
RESOURCE_NOT_FOUND | 404 | Recipient account not found |
RECIPIENT_INACTIVE | 400 | Recipient account is not active |
DUPLICATE_REFERENCE | 409 | Reference already used |
INSUFFICIENT_BALANCE | 402 | Business wallet balance too low |
PAYOUT_LIMIT_EXCEEDED | 400 | Daily or monthly limit exceeded |
VALIDATION_ERROR | 400 | Invalid request data |
Payout Limits
Your app may have daily and monthly payout limits configured. If exceeded, the request returnsPAYOUT_LIMIT_EXCEEDED.
Payouts are instant and irreversible. Always verify the recipient account before sending.
Best Practices
- Verify First: Always call
/accounts/{clientId}before creating a payout - Use References: Use unique references for your records and reconciliation
- Store Payout ID: Keep the
payoutIdfor support and auditing - Check Balance: Ensure sufficient wallet balance before bulk payouts
- Idempotency: Use the same
referenceto prevent duplicate payouts
For bulk payouts, batch your requests and include unique references for each to track individual payments.
Authorizations
JWT access token obtained from /auth/token
Body
application/json
Recipient's Fyatu client ID
Example:
"clt_a1b2c3d4e5f6"
Payout amount in USD
Required range:
x >= 1Example:
100
Description shown to recipient (max 100 chars)
Maximum string length:
100Example:
"January salary payment"
Currency code (only USD supported, other values ignored)
Your unique reference for tracking
Maximum string length:
100Custom data to attach
⌘I

