Record business collection payment (Legacy Alias)
curl --request POST \
--url https://api.nexapay.ng/api/v1/business/process/external \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"businessId": "<string>",
"amount": 123,
"externalPayerName": "<string>",
"payerName": "<string>",
"externalPayerId": "<string>",
"externalPayerEmail": "<string>",
"payerEmail": "<string>",
"externalPayerPhone": "<string>",
"payerPhone": "<string>",
"payerMetadata": {},
"serviceType": "<string>",
"description": "<string>"
}
'import requests
url = "https://api.nexapay.ng/api/v1/business/process/external"
payload = {
"businessId": "<string>",
"amount": 123,
"externalPayerName": "<string>",
"payerName": "<string>",
"externalPayerId": "<string>",
"externalPayerEmail": "<string>",
"payerEmail": "<string>",
"externalPayerPhone": "<string>",
"payerPhone": "<string>",
"payerMetadata": {},
"serviceType": "<string>",
"description": "<string>"
}
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({
businessId: '<string>',
amount: 123,
externalPayerName: '<string>',
payerName: '<string>',
externalPayerId: '<string>',
externalPayerEmail: '<string>',
payerEmail: '<string>',
externalPayerPhone: '<string>',
payerPhone: '<string>',
payerMetadata: {},
serviceType: '<string>',
description: '<string>'
})
};
fetch('https://api.nexapay.ng/api/v1/business/process/external', 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.nexapay.ng/api/v1/business/process/external",
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([
'businessId' => '<string>',
'amount' => 123,
'externalPayerName' => '<string>',
'payerName' => '<string>',
'externalPayerId' => '<string>',
'externalPayerEmail' => '<string>',
'payerEmail' => '<string>',
'externalPayerPhone' => '<string>',
'payerPhone' => '<string>',
'payerMetadata' => [
],
'serviceType' => '<string>',
'description' => '<string>'
]),
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://api.nexapay.ng/api/v1/business/process/external"
payload := strings.NewReader("{\n \"businessId\": \"<string>\",\n \"amount\": 123,\n \"externalPayerName\": \"<string>\",\n \"payerName\": \"<string>\",\n \"externalPayerId\": \"<string>\",\n \"externalPayerEmail\": \"<string>\",\n \"payerEmail\": \"<string>\",\n \"externalPayerPhone\": \"<string>\",\n \"payerPhone\": \"<string>\",\n \"payerMetadata\": {},\n \"serviceType\": \"<string>\",\n \"description\": \"<string>\"\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://api.nexapay.ng/api/v1/business/process/external")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"businessId\": \"<string>\",\n \"amount\": 123,\n \"externalPayerName\": \"<string>\",\n \"payerName\": \"<string>\",\n \"externalPayerId\": \"<string>\",\n \"externalPayerEmail\": \"<string>\",\n \"payerEmail\": \"<string>\",\n \"externalPayerPhone\": \"<string>\",\n \"payerPhone\": \"<string>\",\n \"payerMetadata\": {},\n \"serviceType\": \"<string>\",\n \"description\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.nexapay.ng/api/v1/business/process/external")
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 \"businessId\": \"<string>\",\n \"amount\": 123,\n \"externalPayerName\": \"<string>\",\n \"payerName\": \"<string>\",\n \"externalPayerId\": \"<string>\",\n \"externalPayerEmail\": \"<string>\",\n \"payerEmail\": \"<string>\",\n \"externalPayerPhone\": \"<string>\",\n \"payerPhone\": \"<string>\",\n \"payerMetadata\": {},\n \"serviceType\": \"<string>\",\n \"description\": \"<string>\"\n}"
response = http.request(request)
puts response.read_bodyPayments Collection
Process External Payment (Legacy)
Legacy route matching the functionality of /process. Records a payment collection from an external payer.
POST
/
process
/
external
Record business collection payment (Legacy Alias)
curl --request POST \
--url https://api.nexapay.ng/api/v1/business/process/external \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"businessId": "<string>",
"amount": 123,
"externalPayerName": "<string>",
"payerName": "<string>",
"externalPayerId": "<string>",
"externalPayerEmail": "<string>",
"payerEmail": "<string>",
"externalPayerPhone": "<string>",
"payerPhone": "<string>",
"payerMetadata": {},
"serviceType": "<string>",
"description": "<string>"
}
'import requests
url = "https://api.nexapay.ng/api/v1/business/process/external"
payload = {
"businessId": "<string>",
"amount": 123,
"externalPayerName": "<string>",
"payerName": "<string>",
"externalPayerId": "<string>",
"externalPayerEmail": "<string>",
"payerEmail": "<string>",
"externalPayerPhone": "<string>",
"payerPhone": "<string>",
"payerMetadata": {},
"serviceType": "<string>",
"description": "<string>"
}
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({
businessId: '<string>',
amount: 123,
externalPayerName: '<string>',
payerName: '<string>',
externalPayerId: '<string>',
externalPayerEmail: '<string>',
payerEmail: '<string>',
externalPayerPhone: '<string>',
payerPhone: '<string>',
payerMetadata: {},
serviceType: '<string>',
description: '<string>'
})
};
fetch('https://api.nexapay.ng/api/v1/business/process/external', 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.nexapay.ng/api/v1/business/process/external",
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([
'businessId' => '<string>',
'amount' => 123,
'externalPayerName' => '<string>',
'payerName' => '<string>',
'externalPayerId' => '<string>',
'externalPayerEmail' => '<string>',
'payerEmail' => '<string>',
'externalPayerPhone' => '<string>',
'payerPhone' => '<string>',
'payerMetadata' => [
],
'serviceType' => '<string>',
'description' => '<string>'
]),
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://api.nexapay.ng/api/v1/business/process/external"
payload := strings.NewReader("{\n \"businessId\": \"<string>\",\n \"amount\": 123,\n \"externalPayerName\": \"<string>\",\n \"payerName\": \"<string>\",\n \"externalPayerId\": \"<string>\",\n \"externalPayerEmail\": \"<string>\",\n \"payerEmail\": \"<string>\",\n \"externalPayerPhone\": \"<string>\",\n \"payerPhone\": \"<string>\",\n \"payerMetadata\": {},\n \"serviceType\": \"<string>\",\n \"description\": \"<string>\"\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://api.nexapay.ng/api/v1/business/process/external")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"businessId\": \"<string>\",\n \"amount\": 123,\n \"externalPayerName\": \"<string>\",\n \"payerName\": \"<string>\",\n \"externalPayerId\": \"<string>\",\n \"externalPayerEmail\": \"<string>\",\n \"payerEmail\": \"<string>\",\n \"externalPayerPhone\": \"<string>\",\n \"payerPhone\": \"<string>\",\n \"payerMetadata\": {},\n \"serviceType\": \"<string>\",\n \"description\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.nexapay.ng/api/v1/business/process/external")
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 \"businessId\": \"<string>\",\n \"amount\": 123,\n \"externalPayerName\": \"<string>\",\n \"payerName\": \"<string>\",\n \"externalPayerId\": \"<string>\",\n \"externalPayerEmail\": \"<string>\",\n \"payerEmail\": \"<string>\",\n \"externalPayerPhone\": \"<string>\",\n \"payerPhone\": \"<string>\",\n \"payerMetadata\": {},\n \"serviceType\": \"<string>\",\n \"description\": \"<string>\"\n}"
response = http.request(request)
puts response.read_bodyLegacy route matching the functionality of
/process. Records a payment collection from an external payer.Authorizations
Merchant API Key (e.g., nexa-prod-... or nexa-test-...)
Headers
Target environment selector (live production vs. simulated sandbox).
Available options:
prod, test Body
application/json
Unique business ID.
The transaction amount.
The name of the payer.
Alternative name parameter for the payer.
Response
200
Payment recorded.