Create a Payout
curl --request POST \
--url https://api.viarosandbox.com/v1/payouts \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"amount": {},
"currency": "<string>",
"payout_method_id": "<string>",
"description": "<string>",
"metadata": {}
}
'import requests
url = "https://api.viarosandbox.com/v1/payouts"
payload = {
"amount": {},
"currency": "<string>",
"payout_method_id": "<string>",
"description": "<string>",
"metadata": {}
}
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({
amount: {},
currency: '<string>',
payout_method_id: '<string>',
description: '<string>',
metadata: {}
})
};
fetch('https://api.viarosandbox.com/v1/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.viarosandbox.com/v1/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([
'amount' => [
],
'currency' => '<string>',
'payout_method_id' => '<string>',
'description' => '<string>',
'metadata' => [
]
]),
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.viarosandbox.com/v1/payouts"
payload := strings.NewReader("{\n \"amount\": {},\n \"currency\": \"<string>\",\n \"payout_method_id\": \"<string>\",\n \"description\": \"<string>\",\n \"metadata\": {}\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.viarosandbox.com/v1/payouts")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"amount\": {},\n \"currency\": \"<string>\",\n \"payout_method_id\": \"<string>\",\n \"description\": \"<string>\",\n \"metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.viarosandbox.com/v1/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 \"amount\": {},\n \"currency\": \"<string>\",\n \"payout_method_id\": \"<string>\",\n \"description\": \"<string>\",\n \"metadata\": {}\n}"
response = http.request(request)
puts response.read_bodyPayouts & Settlement
Create a Payout
Send an on-demand payout from your available Pursar balance to a registered payout destination.
POST
/
payouts
Create a Payout
curl --request POST \
--url https://api.viarosandbox.com/v1/payouts \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"amount": {},
"currency": "<string>",
"payout_method_id": "<string>",
"description": "<string>",
"metadata": {}
}
'import requests
url = "https://api.viarosandbox.com/v1/payouts"
payload = {
"amount": {},
"currency": "<string>",
"payout_method_id": "<string>",
"description": "<string>",
"metadata": {}
}
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({
amount: {},
currency: '<string>',
payout_method_id: '<string>',
description: '<string>',
metadata: {}
})
};
fetch('https://api.viarosandbox.com/v1/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.viarosandbox.com/v1/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([
'amount' => [
],
'currency' => '<string>',
'payout_method_id' => '<string>',
'description' => '<string>',
'metadata' => [
]
]),
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.viarosandbox.com/v1/payouts"
payload := strings.NewReader("{\n \"amount\": {},\n \"currency\": \"<string>\",\n \"payout_method_id\": \"<string>\",\n \"description\": \"<string>\",\n \"metadata\": {}\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.viarosandbox.com/v1/payouts")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"amount\": {},\n \"currency\": \"<string>\",\n \"payout_method_id\": \"<string>\",\n \"description\": \"<string>\",\n \"metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.viarosandbox.com/v1/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 \"amount\": {},\n \"currency\": \"<string>\",\n \"payout_method_id\": \"<string>\",\n \"description\": \"<string>\",\n \"metadata\": {}\n}"
response = http.request(request)
puts response.read_bodyInitiate an on-demand payout from your available balance to a registered bank account or mobile money destination.
Request Body
integer | string
required
The amount to disburse (e.g.
100000).string
required
Three-letter ISO currency code (
XAF, XOF, GHS, KES, USD, EUR). Must match the destination currency.string
required
Identifier of the registered payout method (
pm_...).string
An arbitrary string describing the payout for reconciliation statements.
object
Key-value pairs for internal accounting or payroll reference tags.
Code Examples
curl -X POST https://api.viarosandbox.com/v1/payouts \
-u sk_test_uLsofsae3tB9Izwgeuy0Mxbh4JIxUPSG: \
-H "Content-Type: application/json" \
-d '{
"amount": 100000,
"currency": "XAF",
"payout_method_id": "pm_bank_afriland_01",
"description": "Weekly merchant payout"
}'
import requests
url = "https://api.viarosandbox.com/v1/payouts"
auth = ("sk_test_uLsofsae3tB9Izwgeuy0Mxbh4JIxUPSG", "")
payload = {
"amount": 100000,
"currency": "XAF",
"payout_method_id": "pm_bank_afriland_01",
"description": "Weekly merchant payout"
}
response = requests.post(url, auth=auth, json=payload)
print(response.json())
const axios = require('axios');
async function createPayout() {
const response = await axios.post(
'https://api.viarosandbox.com/v1/payouts',
{
amount: 100000,
currency: 'XAF',
payout_method_id: 'pm_bank_afriland_01',
description: 'Weekly merchant payout'
},
{
auth: {
username: 'sk_test_uLsofsae3tB9Izwgeuy0Mxbh4JIxUPSG',
password: ''
}
}
);
console.log(response.data);
}
createPayout();
Response
{
"id": "po_7a1b2c3d4e5f",
"object": "payout",
"amount": 100000,
"currency": "XAF",
"status": "pending",
"arrival_date": "2026-11-06T18:00:00Z",
"description": "Weekly merchant payout",
"destination": "pm_bank_afriland_01",
"method": "standard",
"created_at": "2026-11-06T12:00:00Z"
}

