Request a Disbursement
curl --request POST \
--url https://sandbox-api.payfonte.com/billing/v1/disbursements \
--header 'Content-Type: application/json' \
--header 'client-id: <api-key>' \
--header 'client-secret: <api-key>' \
--data '
{
"transferRecipientId": "6659692f019f6a143f7f90db",
"amount": 100000,
"reference": "<string>",
"narration": "Transfer of 100",
"pin": "<string>",
"webhookURL": "https://example.com/webhook",
"metadata": {
"merchantName": "Karis Clothing",
"trafficType": "ECOMMERCE"
}
}
'import requests
url = "https://sandbox-api.payfonte.com/billing/v1/disbursements"
payload = {
"transferRecipientId": "6659692f019f6a143f7f90db",
"amount": 100000,
"reference": "<string>",
"narration": "Transfer of 100",
"pin": "<string>",
"webhookURL": "https://example.com/webhook",
"metadata": {
"merchantName": "Karis Clothing",
"trafficType": "ECOMMERCE"
}
}
headers = {
"client-id": "<api-key>",
"client-secret": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'client-id': '<api-key>',
'client-secret': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
transferRecipientId: '6659692f019f6a143f7f90db',
amount: 100000,
reference: '<string>',
narration: 'Transfer of 100',
pin: '<string>',
webhookURL: 'https://example.com/webhook',
metadata: {merchantName: 'Karis Clothing', trafficType: 'ECOMMERCE'}
})
};
fetch('https://sandbox-api.payfonte.com/billing/v1/disbursements', 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://sandbox-api.payfonte.com/billing/v1/disbursements",
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([
'transferRecipientId' => '6659692f019f6a143f7f90db',
'amount' => 100000,
'reference' => '<string>',
'narration' => 'Transfer of 100',
'pin' => '<string>',
'webhookURL' => 'https://example.com/webhook',
'metadata' => [
'merchantName' => 'Karis Clothing',
'trafficType' => 'ECOMMERCE'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"client-id: <api-key>",
"client-secret: <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://sandbox-api.payfonte.com/billing/v1/disbursements"
payload := strings.NewReader("{\n \"transferRecipientId\": \"6659692f019f6a143f7f90db\",\n \"amount\": 100000,\n \"reference\": \"<string>\",\n \"narration\": \"Transfer of 100\",\n \"pin\": \"<string>\",\n \"webhookURL\": \"https://example.com/webhook\",\n \"metadata\": {\n \"merchantName\": \"Karis Clothing\",\n \"trafficType\": \"ECOMMERCE\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("client-id", "<api-key>")
req.Header.Add("client-secret", "<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://sandbox-api.payfonte.com/billing/v1/disbursements")
.header("client-id", "<api-key>")
.header("client-secret", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"transferRecipientId\": \"6659692f019f6a143f7f90db\",\n \"amount\": 100000,\n \"reference\": \"<string>\",\n \"narration\": \"Transfer of 100\",\n \"pin\": \"<string>\",\n \"webhookURL\": \"https://example.com/webhook\",\n \"metadata\": {\n \"merchantName\": \"Karis Clothing\",\n \"trafficType\": \"ECOMMERCE\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox-api.payfonte.com/billing/v1/disbursements")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["client-id"] = '<api-key>'
request["client-secret"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"transferRecipientId\": \"6659692f019f6a143f7f90db\",\n \"amount\": 100000,\n \"reference\": \"<string>\",\n \"narration\": \"Transfer of 100\",\n \"pin\": \"<string>\",\n \"webhookURL\": \"https://example.com/webhook\",\n \"metadata\": {\n \"merchantName\": \"Karis Clothing\",\n \"trafficType\": \"ECOMMERCE\"\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"reference": "<string>",
"amount": 100000,
"amountPayable": 100000,
"provider": "<string>",
"currency": "USD, NGN, XOF, XAF",
"country": "US, NG, CI, SN, CA, UK"
}
}Disbursements
Request a Disbursement
Request a Disbursement to a Transfer Recipient
POST
/
billing
/
v1
/
disbursements
Request a Disbursement
curl --request POST \
--url https://sandbox-api.payfonte.com/billing/v1/disbursements \
--header 'Content-Type: application/json' \
--header 'client-id: <api-key>' \
--header 'client-secret: <api-key>' \
--data '
{
"transferRecipientId": "6659692f019f6a143f7f90db",
"amount": 100000,
"reference": "<string>",
"narration": "Transfer of 100",
"pin": "<string>",
"webhookURL": "https://example.com/webhook",
"metadata": {
"merchantName": "Karis Clothing",
"trafficType": "ECOMMERCE"
}
}
'import requests
url = "https://sandbox-api.payfonte.com/billing/v1/disbursements"
payload = {
"transferRecipientId": "6659692f019f6a143f7f90db",
"amount": 100000,
"reference": "<string>",
"narration": "Transfer of 100",
"pin": "<string>",
"webhookURL": "https://example.com/webhook",
"metadata": {
"merchantName": "Karis Clothing",
"trafficType": "ECOMMERCE"
}
}
headers = {
"client-id": "<api-key>",
"client-secret": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'client-id': '<api-key>',
'client-secret': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
transferRecipientId: '6659692f019f6a143f7f90db',
amount: 100000,
reference: '<string>',
narration: 'Transfer of 100',
pin: '<string>',
webhookURL: 'https://example.com/webhook',
metadata: {merchantName: 'Karis Clothing', trafficType: 'ECOMMERCE'}
})
};
fetch('https://sandbox-api.payfonte.com/billing/v1/disbursements', 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://sandbox-api.payfonte.com/billing/v1/disbursements",
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([
'transferRecipientId' => '6659692f019f6a143f7f90db',
'amount' => 100000,
'reference' => '<string>',
'narration' => 'Transfer of 100',
'pin' => '<string>',
'webhookURL' => 'https://example.com/webhook',
'metadata' => [
'merchantName' => 'Karis Clothing',
'trafficType' => 'ECOMMERCE'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"client-id: <api-key>",
"client-secret: <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://sandbox-api.payfonte.com/billing/v1/disbursements"
payload := strings.NewReader("{\n \"transferRecipientId\": \"6659692f019f6a143f7f90db\",\n \"amount\": 100000,\n \"reference\": \"<string>\",\n \"narration\": \"Transfer of 100\",\n \"pin\": \"<string>\",\n \"webhookURL\": \"https://example.com/webhook\",\n \"metadata\": {\n \"merchantName\": \"Karis Clothing\",\n \"trafficType\": \"ECOMMERCE\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("client-id", "<api-key>")
req.Header.Add("client-secret", "<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://sandbox-api.payfonte.com/billing/v1/disbursements")
.header("client-id", "<api-key>")
.header("client-secret", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"transferRecipientId\": \"6659692f019f6a143f7f90db\",\n \"amount\": 100000,\n \"reference\": \"<string>\",\n \"narration\": \"Transfer of 100\",\n \"pin\": \"<string>\",\n \"webhookURL\": \"https://example.com/webhook\",\n \"metadata\": {\n \"merchantName\": \"Karis Clothing\",\n \"trafficType\": \"ECOMMERCE\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox-api.payfonte.com/billing/v1/disbursements")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["client-id"] = '<api-key>'
request["client-secret"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"transferRecipientId\": \"6659692f019f6a143f7f90db\",\n \"amount\": 100000,\n \"reference\": \"<string>\",\n \"narration\": \"Transfer of 100\",\n \"pin\": \"<string>\",\n \"webhookURL\": \"https://example.com/webhook\",\n \"metadata\": {\n \"merchantName\": \"Karis Clothing\",\n \"trafficType\": \"ECOMMERCE\"\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"reference": "<string>",
"amount": 100000,
"amountPayable": 100000,
"provider": "<string>",
"currency": "USD, NGN, XOF, XAF",
"country": "US, NG, CI, SN, CA, UK"
}
}Body
application/json
Request a Disbursement
id of a transfer recipient gotten from the response of TransferRecipient Call
Example:
"6659692f019f6a143f7f90db"
Amount should be in the subunit of the supported currency i.e value * 100 Amount Specification
Example:
100000
A reference code you'll generate to identify this transaction. This must be unique for every transaction. If you don't pass one, we will generate one for you.
Example:
"Transfer of 100"
This is your disbursement pin. This is a form of disbursement authorization. Alternative is an Authorization URL
Show child attributes
Show child attributes
Response
201 - application/json
Request for Disbursement Successful
Show child attributes
Show child attributes
⌘I