Create a payout from the merchant master NGN wallet
curl --request POST \
--url https://api-production.fossapay.com/api/v1/payouts \
--header 'Content-Type: application/json' \
--header 'X-Idempotency-Key: <x-idempotency-key>' \
--header 'x-api-key: <api-key>' \
--data '
{
"amount": 2,
"currency": "NGN",
"reference": "<string>",
"destinationBankCode": "<string>",
"destinationBankName": "<string>",
"destinationAccountName": "<string>",
"destinationAccountNumber": "<string>",
"remarks": "<string>",
"metadata": {}
}
'import requests
url = "https://api-production.fossapay.com/api/v1/payouts"
payload = {
"amount": 2,
"currency": "NGN",
"reference": "<string>",
"destinationBankCode": "<string>",
"destinationBankName": "<string>",
"destinationAccountName": "<string>",
"destinationAccountNumber": "<string>",
"remarks": "<string>",
"metadata": {}
}
headers = {
"X-Idempotency-Key": "<x-idempotency-key>",
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'X-Idempotency-Key': '<x-idempotency-key>',
'x-api-key': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
amount: 2,
currency: 'NGN',
reference: '<string>',
destinationBankCode: '<string>',
destinationBankName: '<string>',
destinationAccountName: '<string>',
destinationAccountNumber: '<string>',
remarks: '<string>',
metadata: {}
})
};
fetch('https://api-production.fossapay.com/api/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-production.fossapay.com/api/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' => 2,
'currency' => 'NGN',
'reference' => '<string>',
'destinationBankCode' => '<string>',
'destinationBankName' => '<string>',
'destinationAccountName' => '<string>',
'destinationAccountNumber' => '<string>',
'remarks' => '<string>',
'metadata' => [
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Idempotency-Key: <x-idempotency-key>",
"x-api-key: <api-key>"
],
]);
$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-production.fossapay.com/api/v1/payouts"
payload := strings.NewReader("{\n \"amount\": 2,\n \"currency\": \"NGN\",\n \"reference\": \"<string>\",\n \"destinationBankCode\": \"<string>\",\n \"destinationBankName\": \"<string>\",\n \"destinationAccountName\": \"<string>\",\n \"destinationAccountNumber\": \"<string>\",\n \"remarks\": \"<string>\",\n \"metadata\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Idempotency-Key", "<x-idempotency-key>")
req.Header.Add("x-api-key", "<api-key>")
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-production.fossapay.com/api/v1/payouts")
.header("X-Idempotency-Key", "<x-idempotency-key>")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"amount\": 2,\n \"currency\": \"NGN\",\n \"reference\": \"<string>\",\n \"destinationBankCode\": \"<string>\",\n \"destinationBankName\": \"<string>\",\n \"destinationAccountName\": \"<string>\",\n \"destinationAccountNumber\": \"<string>\",\n \"remarks\": \"<string>\",\n \"metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-production.fossapay.com/api/v1/payouts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Idempotency-Key"] = '<x-idempotency-key>'
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"amount\": 2,\n \"currency\": \"NGN\",\n \"reference\": \"<string>\",\n \"destinationBankCode\": \"<string>\",\n \"destinationBankName\": \"<string>\",\n \"destinationAccountName\": \"<string>\",\n \"destinationAccountNumber\": \"<string>\",\n \"remarks\": \"<string>\",\n \"metadata\": {}\n}"
response = http.request(request)
puts response.read_body{
"status": "success",
"statusCode": 200,
"message": "<string>",
"data": {
"payoutId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"transactionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"reference": "<string>",
"status": "processing",
"route": "same_business",
"amount": "<string>",
"fee": "<string>",
"totalDebited": "<string>",
"currency": "NGN",
"recipient": {
"bankCode": "<string>",
"bankName": "<string>",
"accountName": "<string>",
"accountNumber": "<string>"
},
"providerReference": "<string>",
"metadata": {},
"completedAt": "2023-11-07T05:31:56Z",
"failedAt": "2023-11-07T05:31:56Z",
"reversedAt": "2023-11-07T05:31:56Z"
}
}{
"status": "<string>",
"statusCode": 123,
"message": "<string>",
"error": "<string>",
"code": "<string>",
"errors": {}
}{
"status": "<string>",
"statusCode": 123,
"message": "<string>",
"error": "<string>",
"code": "<string>",
"errors": {}
}{
"status": "<string>",
"statusCode": 123,
"message": "<string>",
"error": "<string>",
"code": "<string>",
"errors": {}
}{
"status": "<string>",
"statusCode": 123,
"message": "<string>",
"error": "<string>",
"code": "<string>",
"errors": {}
}Master Wallet Payouts
Create a payout from the merchant master NGN wallet
The source wallet is derived from the authenticated merchant. Same-business destinations are free; cross-business FossaPay and external-bank destinations incur the configured payout fee.
POST
/
api
/
v1
/
payouts
Create a payout from the merchant master NGN wallet
curl --request POST \
--url https://api-production.fossapay.com/api/v1/payouts \
--header 'Content-Type: application/json' \
--header 'X-Idempotency-Key: <x-idempotency-key>' \
--header 'x-api-key: <api-key>' \
--data '
{
"amount": 2,
"currency": "NGN",
"reference": "<string>",
"destinationBankCode": "<string>",
"destinationBankName": "<string>",
"destinationAccountName": "<string>",
"destinationAccountNumber": "<string>",
"remarks": "<string>",
"metadata": {}
}
'import requests
url = "https://api-production.fossapay.com/api/v1/payouts"
payload = {
"amount": 2,
"currency": "NGN",
"reference": "<string>",
"destinationBankCode": "<string>",
"destinationBankName": "<string>",
"destinationAccountName": "<string>",
"destinationAccountNumber": "<string>",
"remarks": "<string>",
"metadata": {}
}
headers = {
"X-Idempotency-Key": "<x-idempotency-key>",
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'X-Idempotency-Key': '<x-idempotency-key>',
'x-api-key': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
amount: 2,
currency: 'NGN',
reference: '<string>',
destinationBankCode: '<string>',
destinationBankName: '<string>',
destinationAccountName: '<string>',
destinationAccountNumber: '<string>',
remarks: '<string>',
metadata: {}
})
};
fetch('https://api-production.fossapay.com/api/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-production.fossapay.com/api/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' => 2,
'currency' => 'NGN',
'reference' => '<string>',
'destinationBankCode' => '<string>',
'destinationBankName' => '<string>',
'destinationAccountName' => '<string>',
'destinationAccountNumber' => '<string>',
'remarks' => '<string>',
'metadata' => [
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Idempotency-Key: <x-idempotency-key>",
"x-api-key: <api-key>"
],
]);
$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-production.fossapay.com/api/v1/payouts"
payload := strings.NewReader("{\n \"amount\": 2,\n \"currency\": \"NGN\",\n \"reference\": \"<string>\",\n \"destinationBankCode\": \"<string>\",\n \"destinationBankName\": \"<string>\",\n \"destinationAccountName\": \"<string>\",\n \"destinationAccountNumber\": \"<string>\",\n \"remarks\": \"<string>\",\n \"metadata\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Idempotency-Key", "<x-idempotency-key>")
req.Header.Add("x-api-key", "<api-key>")
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-production.fossapay.com/api/v1/payouts")
.header("X-Idempotency-Key", "<x-idempotency-key>")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"amount\": 2,\n \"currency\": \"NGN\",\n \"reference\": \"<string>\",\n \"destinationBankCode\": \"<string>\",\n \"destinationBankName\": \"<string>\",\n \"destinationAccountName\": \"<string>\",\n \"destinationAccountNumber\": \"<string>\",\n \"remarks\": \"<string>\",\n \"metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-production.fossapay.com/api/v1/payouts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Idempotency-Key"] = '<x-idempotency-key>'
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"amount\": 2,\n \"currency\": \"NGN\",\n \"reference\": \"<string>\",\n \"destinationBankCode\": \"<string>\",\n \"destinationBankName\": \"<string>\",\n \"destinationAccountName\": \"<string>\",\n \"destinationAccountNumber\": \"<string>\",\n \"remarks\": \"<string>\",\n \"metadata\": {}\n}"
response = http.request(request)
puts response.read_body{
"status": "success",
"statusCode": 200,
"message": "<string>",
"data": {
"payoutId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"transactionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"reference": "<string>",
"status": "processing",
"route": "same_business",
"amount": "<string>",
"fee": "<string>",
"totalDebited": "<string>",
"currency": "NGN",
"recipient": {
"bankCode": "<string>",
"bankName": "<string>",
"accountName": "<string>",
"accountNumber": "<string>"
},
"providerReference": "<string>",
"metadata": {},
"completedAt": "2023-11-07T05:31:56Z",
"failedAt": "2023-11-07T05:31:56Z",
"reversedAt": "2023-11-07T05:31:56Z"
}
}{
"status": "<string>",
"statusCode": 123,
"message": "<string>",
"error": "<string>",
"code": "<string>",
"errors": {}
}{
"status": "<string>",
"statusCode": 123,
"message": "<string>",
"error": "<string>",
"code": "<string>",
"errors": {}
}{
"status": "<string>",
"statusCode": 123,
"message": "<string>",
"error": "<string>",
"code": "<string>",
"errors": {}
}{
"status": "<string>",
"statusCode": 123,
"message": "<string>",
"error": "<string>",
"code": "<string>",
"errors": {}
}Authorizations
Headers
Unique key for this logical payout. Idempotency-Key is also accepted; if both headers are sent, they must match.
Maximum string length:
255Body
application/json
Amount the beneficiary receives in NGN.
Required range:
x >= 1Available options:
NGN Required string length:
1 - 100Pattern:
^[A-Za-z0-9._:-]+$Required string length:
1 - 100Required string length:
1 - 199Required string length:
1 - 199Required string length:
1 - 199Maximum string length:
255Optional merchant data limited to 4,096 UTF-8 bytes and returned unchanged.

