curl --request POST \
--url https://sandbox.api.afriex.com/api/v1/payment-batch/{batchId}/recipients \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"channel": "BANK_ACCOUNT",
"countryCode": "NG",
"amount": {
"value": "15000",
"currencyCode": "NGN"
},
"paymentMethodId": "<string>",
"accountName": "<string>",
"accountNumber": "<string>",
"institution": {}
}
'import requests
url = "https://sandbox.api.afriex.com/api/v1/payment-batch/{batchId}/recipients"
payload = {
"channel": "BANK_ACCOUNT",
"countryCode": "NG",
"amount": {
"value": "15000",
"currencyCode": "NGN"
},
"paymentMethodId": "<string>",
"accountName": "<string>",
"accountNumber": "<string>",
"institution": {}
}
headers = {
"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-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
channel: 'BANK_ACCOUNT',
countryCode: 'NG',
amount: {value: '15000', currencyCode: 'NGN'},
paymentMethodId: '<string>',
accountName: '<string>',
accountNumber: '<string>',
institution: {}
})
};
fetch('https://sandbox.api.afriex.com/api/v1/payment-batch/{batchId}/recipients', 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.afriex.com/api/v1/payment-batch/{batchId}/recipients",
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([
'channel' => 'BANK_ACCOUNT',
'countryCode' => 'NG',
'amount' => [
'value' => '15000',
'currencyCode' => 'NGN'
],
'paymentMethodId' => '<string>',
'accountName' => '<string>',
'accountNumber' => '<string>',
'institution' => [
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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://sandbox.api.afriex.com/api/v1/payment-batch/{batchId}/recipients"
payload := strings.NewReader("{\n \"channel\": \"BANK_ACCOUNT\",\n \"countryCode\": \"NG\",\n \"amount\": {\n \"value\": \"15000\",\n \"currencyCode\": \"NGN\"\n },\n \"paymentMethodId\": \"<string>\",\n \"accountName\": \"<string>\",\n \"accountNumber\": \"<string>\",\n \"institution\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
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://sandbox.api.afriex.com/api/v1/payment-batch/{batchId}/recipients")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"channel\": \"BANK_ACCOUNT\",\n \"countryCode\": \"NG\",\n \"amount\": {\n \"value\": \"15000\",\n \"currencyCode\": \"NGN\"\n },\n \"paymentMethodId\": \"<string>\",\n \"accountName\": \"<string>\",\n \"accountNumber\": \"<string>\",\n \"institution\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.api.afriex.com/api/v1/payment-batch/{batchId}/recipients")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"channel\": \"BANK_ACCOUNT\",\n \"countryCode\": \"NG\",\n \"amount\": {\n \"value\": \"15000\",\n \"currencyCode\": \"NGN\"\n },\n \"paymentMethodId\": \"<string>\",\n \"accountName\": \"<string>\",\n \"accountNumber\": \"<string>\",\n \"institution\": {}\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"channel": "<string>",
"countryCode": "<string>"
}
}Add Recipient to Batch
Pass paymentMethodId to update that saved account of the business and add it to the batch, instead of creating a new one. Requires the PAYMENT_BATCH.UPDATE key permission.
curl --request POST \
--url https://sandbox.api.afriex.com/api/v1/payment-batch/{batchId}/recipients \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"channel": "BANK_ACCOUNT",
"countryCode": "NG",
"amount": {
"value": "15000",
"currencyCode": "NGN"
},
"paymentMethodId": "<string>",
"accountName": "<string>",
"accountNumber": "<string>",
"institution": {}
}
'import requests
url = "https://sandbox.api.afriex.com/api/v1/payment-batch/{batchId}/recipients"
payload = {
"channel": "BANK_ACCOUNT",
"countryCode": "NG",
"amount": {
"value": "15000",
"currencyCode": "NGN"
},
"paymentMethodId": "<string>",
"accountName": "<string>",
"accountNumber": "<string>",
"institution": {}
}
headers = {
"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-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
channel: 'BANK_ACCOUNT',
countryCode: 'NG',
amount: {value: '15000', currencyCode: 'NGN'},
paymentMethodId: '<string>',
accountName: '<string>',
accountNumber: '<string>',
institution: {}
})
};
fetch('https://sandbox.api.afriex.com/api/v1/payment-batch/{batchId}/recipients', 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.afriex.com/api/v1/payment-batch/{batchId}/recipients",
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([
'channel' => 'BANK_ACCOUNT',
'countryCode' => 'NG',
'amount' => [
'value' => '15000',
'currencyCode' => 'NGN'
],
'paymentMethodId' => '<string>',
'accountName' => '<string>',
'accountNumber' => '<string>',
'institution' => [
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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://sandbox.api.afriex.com/api/v1/payment-batch/{batchId}/recipients"
payload := strings.NewReader("{\n \"channel\": \"BANK_ACCOUNT\",\n \"countryCode\": \"NG\",\n \"amount\": {\n \"value\": \"15000\",\n \"currencyCode\": \"NGN\"\n },\n \"paymentMethodId\": \"<string>\",\n \"accountName\": \"<string>\",\n \"accountNumber\": \"<string>\",\n \"institution\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
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://sandbox.api.afriex.com/api/v1/payment-batch/{batchId}/recipients")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"channel\": \"BANK_ACCOUNT\",\n \"countryCode\": \"NG\",\n \"amount\": {\n \"value\": \"15000\",\n \"currencyCode\": \"NGN\"\n },\n \"paymentMethodId\": \"<string>\",\n \"accountName\": \"<string>\",\n \"accountNumber\": \"<string>\",\n \"institution\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.api.afriex.com/api/v1/payment-batch/{batchId}/recipients")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"channel\": \"BANK_ACCOUNT\",\n \"countryCode\": \"NG\",\n \"amount\": {\n \"value\": \"15000\",\n \"currencyCode\": \"NGN\"\n },\n \"paymentMethodId\": \"<string>\",\n \"accountName\": \"<string>\",\n \"accountNumber\": \"<string>\",\n \"institution\": {}\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"channel": "<string>",
"countryCode": "<string>"
}
}Authorizations
Static business API key issued from the dashboard. A business can provision multiple API keys, each scoped to a configurable set of permissions (e.g. read transactions, create deposits, etc). Permissions are chosen per key at creation time in the dashboard and may be revoked by deleting the key. Manage your keys and their permissions under Developer → API keys in the dashboard.
A request whose key does not carry the permission the target
endpoint requires is rejected with 401 Unauthorized, the same
response an unrecognised, malformed, revoked or disabled key
returns. The API does not distinguish the two cases on the wire.
See the Permissions reference for the permission each endpoint requires.
Headers
Body
The account to pay, in the same shape POST /api/v1/payment-method accepts, plus the amount to pay it in this batch. accountName, accountNumber and institution are required for most channels: institution is not used for UPI and INTERAC, and accountName and accountNumber are not used for VIRTUAL_BANK_ACCOUNT. paymentMethodId updates an existing saved account of this business in place instead of creating one.
