Get cross-border collection status
curl --request GET \
--url https://api.nexapay.ng/api/v1/business/cross-border/collections/{reference} \
--header 'x-api-key: <api-key>'import requests
url = "https://api.nexapay.ng/api/v1/business/cross-border/collections/{reference}"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.nexapay.ng/api/v1/business/cross-border/collections/{reference}', 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/cross-border/collections/{reference}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)
func main() {
url := "https://api.nexapay.ng/api/v1/business/cross-border/collections/{reference}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.nexapay.ng/api/v1/business/cross-border/collections/{reference}")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.nexapay.ng/api/v1/business/cross-border/collections/{reference}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"success": true,
"collection": {
"transactionId": "NexaPay20260903140945570d4ed2170c3",
"reference": "NexaPay20260903140945570d4ed2170c3",
"merchantReference": "ORDER-TEST-001",
"status": "PROCESSING",
"sourceAmount": 20000,
"sourceCurrency": "UGX",
"targetAmount": 7200,
"targetCurrency": "NGN",
"rate": 0.36,
"providerRate": 0.4,
"provider": "brails",
"country": "UG",
"paymentMethod": "MTN",
"createdAt": "2023-11-07T05:31:56Z",
"completedAt": "2023-11-07T05:31:56Z",
"failedAt": "2023-11-07T05:31:56Z",
"failureReason": "<string>"
}
}Cross-Border Collections
Get Cross-Border Collection
Returns the current status and locked FX details for a cross-border collection.
GET
/
cross-border
/
collections
/
{reference}
Get cross-border collection status
curl --request GET \
--url https://api.nexapay.ng/api/v1/business/cross-border/collections/{reference} \
--header 'x-api-key: <api-key>'import requests
url = "https://api.nexapay.ng/api/v1/business/cross-border/collections/{reference}"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.nexapay.ng/api/v1/business/cross-border/collections/{reference}', 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/cross-border/collections/{reference}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)
func main() {
url := "https://api.nexapay.ng/api/v1/business/cross-border/collections/{reference}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.nexapay.ng/api/v1/business/cross-border/collections/{reference}")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.nexapay.ng/api/v1/business/cross-border/collections/{reference}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"success": true,
"collection": {
"transactionId": "NexaPay20260903140945570d4ed2170c3",
"reference": "NexaPay20260903140945570d4ed2170c3",
"merchantReference": "ORDER-TEST-001",
"status": "PROCESSING",
"sourceAmount": 20000,
"sourceCurrency": "UGX",
"targetAmount": 7200,
"targetCurrency": "NGN",
"rate": 0.36,
"providerRate": 0.4,
"provider": "brails",
"country": "UG",
"paymentMethod": "MTN",
"createdAt": "2023-11-07T05:31:56Z",
"completedAt": "2023-11-07T05:31:56Z",
"failedAt": "2023-11-07T05:31:56Z",
"failureReason": "<string>"
}
}Returns the status and locked FX details for a cross-border collection.
Use this endpoint to poll collection state when a customer is still approving the local payment request.
Authorizations
Merchant API Key (e.g., nexa-prod-... or nexa-test-...)
Headers
Target environment selector (live production vs. simulated sandbox).
Available options:
prod, test Path Parameters
NexaPay collection reference.
Query Parameters
The unique ID of the business profile (required for API key authentication).