Get collection by reference
curl --request GET \
--url https://api.usebila.com/api/v1/bila/collections/status/{reference} \
--header 'x-api-key: <api-key>'import requests
url = "https://api.usebila.com/api/v1/bila/collections/status/{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.usebila.com/api/v1/bila/collections/status/{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.usebila.com/api/v1/bila/collections/status/{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.usebila.com/api/v1/bila/collections/status/{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.usebila.com/api/v1/bila/collections/status/{reference}")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.usebila.com/api/v1/bila/collections/status/{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{
"status": true,
"message": "Operation completed successfully",
"data": {
"id": "col-001",
"reference": "order-12345",
"status": "successful",
"amount": 100,
"currency": "ZMW",
"customer": {
"phone": "0977123456",
"name": "JOHN DOE",
"operator": "airtel"
},
"createdAt": "2024-01-15T10:30:00Z",
"narration": "Payment for Order #12345",
"completedAt": "2024-01-15T10:31:00Z"
}
}Collections
Get collection by reference
Retrieve collection status by client reference
GET
/
api
/
v1
/
bila
/
collections
/
status
/
{reference}
Get collection by reference
curl --request GET \
--url https://api.usebila.com/api/v1/bila/collections/status/{reference} \
--header 'x-api-key: <api-key>'import requests
url = "https://api.usebila.com/api/v1/bila/collections/status/{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.usebila.com/api/v1/bila/collections/status/{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.usebila.com/api/v1/bila/collections/status/{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.usebila.com/api/v1/bila/collections/status/{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.usebila.com/api/v1/bila/collections/status/{reference}")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.usebila.com/api/v1/bila/collections/status/{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{
"status": true,
"message": "Operation completed successfully",
"data": {
"id": "col-001",
"reference": "order-12345",
"status": "successful",
"amount": 100,
"currency": "ZMW",
"customer": {
"phone": "0977123456",
"name": "JOHN DOE",
"operator": "airtel"
},
"createdAt": "2024-01-15T10:30:00Z",
"narration": "Payment for Order #12345",
"completedAt": "2024-01-15T10:31:00Z"
}
}Authorizations
Merchant API key (e.g., sk_live_xxx or sk_test_xxx)
Path Parameters
Client reference
Example:
"collection-001"
Was this page helpful?
⌘I
