Validate A Transfer Recipient
curl --request POST \
--url https://sandbox-api.payfonte.com/billing/v1/transfer-recipients/validate \
--header 'Content-Type: application/json' \
--header 'client-id: <api-key>' \
--header 'client-secret: <api-key>' \
--data '
{
"currency": "USD, NGN, XOF, XAF",
"country": "US, NG, CI, SN, CA, UK",
"provider": "<string>",
"account": {
"phoneNumber": "2347012345678"
}
}
'import requests
url = "https://sandbox-api.payfonte.com/billing/v1/transfer-recipients/validate"
payload = {
"currency": "USD, NGN, XOF, XAF",
"country": "US, NG, CI, SN, CA, UK",
"provider": "<string>",
"account": { "phoneNumber": "2347012345678" }
}
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({
currency: 'USD, NGN, XOF, XAF',
country: 'US, NG, CI, SN, CA, UK',
provider: '<string>',
account: {phoneNumber: '2347012345678'}
})
};
fetch('https://sandbox-api.payfonte.com/billing/v1/transfer-recipients/validate', 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/transfer-recipients/validate",
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([
'currency' => 'USD, NGN, XOF, XAF',
'country' => 'US, NG, CI, SN, CA, UK',
'provider' => '<string>',
'account' => [
'phoneNumber' => '2347012345678'
]
]),
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/transfer-recipients/validate"
payload := strings.NewReader("{\n \"currency\": \"USD, NGN, XOF, XAF\",\n \"country\": \"US, NG, CI, SN, CA, UK\",\n \"provider\": \"<string>\",\n \"account\": {\n \"phoneNumber\": \"2347012345678\"\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/transfer-recipients/validate")
.header("client-id", "<api-key>")
.header("client-secret", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"currency\": \"USD, NGN, XOF, XAF\",\n \"country\": \"US, NG, CI, SN, CA, UK\",\n \"provider\": \"<string>\",\n \"account\": {\n \"phoneNumber\": \"2347012345678\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox-api.payfonte.com/billing/v1/transfer-recipients/validate")
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 \"currency\": \"USD, NGN, XOF, XAF\",\n \"country\": \"US, NG, CI, SN, CA, UK\",\n \"provider\": \"<string>\",\n \"account\": {\n \"phoneNumber\": \"2347012345678\"\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"currency": "USD, NGN, XOF, XAF",
"country": "US, NG, CI, SN, CA, UK",
"provider": "<string>",
"accountLabel": "Bank Transfer | Zenith Bank | Dummy User | 0123456789",
"account": {
"phoneNumber": "2347012345678"
}
}
}Disbursements
Validate A Transfer Recipient
Create and Validate a Transfer Recipient for Disbursements
POST
/
billing
/
v1
/
transfer-recipients
/
validate
Validate A Transfer Recipient
curl --request POST \
--url https://sandbox-api.payfonte.com/billing/v1/transfer-recipients/validate \
--header 'Content-Type: application/json' \
--header 'client-id: <api-key>' \
--header 'client-secret: <api-key>' \
--data '
{
"currency": "USD, NGN, XOF, XAF",
"country": "US, NG, CI, SN, CA, UK",
"provider": "<string>",
"account": {
"phoneNumber": "2347012345678"
}
}
'import requests
url = "https://sandbox-api.payfonte.com/billing/v1/transfer-recipients/validate"
payload = {
"currency": "USD, NGN, XOF, XAF",
"country": "US, NG, CI, SN, CA, UK",
"provider": "<string>",
"account": { "phoneNumber": "2347012345678" }
}
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({
currency: 'USD, NGN, XOF, XAF',
country: 'US, NG, CI, SN, CA, UK',
provider: '<string>',
account: {phoneNumber: '2347012345678'}
})
};
fetch('https://sandbox-api.payfonte.com/billing/v1/transfer-recipients/validate', 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/transfer-recipients/validate",
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([
'currency' => 'USD, NGN, XOF, XAF',
'country' => 'US, NG, CI, SN, CA, UK',
'provider' => '<string>',
'account' => [
'phoneNumber' => '2347012345678'
]
]),
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/transfer-recipients/validate"
payload := strings.NewReader("{\n \"currency\": \"USD, NGN, XOF, XAF\",\n \"country\": \"US, NG, CI, SN, CA, UK\",\n \"provider\": \"<string>\",\n \"account\": {\n \"phoneNumber\": \"2347012345678\"\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/transfer-recipients/validate")
.header("client-id", "<api-key>")
.header("client-secret", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"currency\": \"USD, NGN, XOF, XAF\",\n \"country\": \"US, NG, CI, SN, CA, UK\",\n \"provider\": \"<string>\",\n \"account\": {\n \"phoneNumber\": \"2347012345678\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox-api.payfonte.com/billing/v1/transfer-recipients/validate")
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 \"currency\": \"USD, NGN, XOF, XAF\",\n \"country\": \"US, NG, CI, SN, CA, UK\",\n \"provider\": \"<string>\",\n \"account\": {\n \"phoneNumber\": \"2347012345678\"\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"currency": "USD, NGN, XOF, XAF",
"country": "US, NG, CI, SN, CA, UK",
"provider": "<string>",
"accountLabel": "Bank Transfer | Zenith Bank | Dummy User | 0123456789",
"account": {
"phoneNumber": "2347012345678"
}
}
}Body
application/json
Validate a Transfer Recipient
3 character currency code
Examples:
"NGN"
"USD"
"XOF"
"XAF"
2 character country code
Examples:
"NG"
"US"
"CI"
"SN"
"CA"
"UK"
This is the provider we are validating the account against. Find full list of providers here Supported Providers
Example:
"provider-slug"
- Option 1
- Option 2
- Option 3
Show child attributes
Show child attributes
Response
201 - application/json
Transfer Recipient Successfully Validated
Show child attributes
Show child attributes
⌘I