Get invoice
curl --request GET \
--url https://api.obiex.finance/v1/invoices/{invoiceId} \
--header 'x-api-key: <api-key>'import requests
url = "https://api.obiex.finance/v1/invoices/{invoiceId}"
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.obiex.finance/v1/invoices/{invoiceId}', 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.obiex.finance/v1/invoices/{invoiceId}",
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.obiex.finance/v1/invoices/{invoiceId}"
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.obiex.finance/v1/invoices/{invoiceId}")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.obiex.finance/v1/invoices/{invoiceId}")
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{
"message": "Ok",
"data": {
"id": "a3f1c2d4-8b0e-4f3a-9c7d-1e2b3a4c5d6e",
"createdAt": "2026-06-10T11:00:00.000Z",
"updatedAt": "2026-06-10T12:45:00.000Z",
"status": "COMPLETED",
"sourceCurrency": "NGN",
"sourceAmount": 1625000,
"targetCurrency": "USD",
"targetAmount": 1000,
"rate": 1625,
"purposeOfPayment": "Payment for software development services",
"invoiceDocument": "https://res.cloudinary.com/afrivelle/image/upload/v1718000000/invoice_abc123.pdf",
"virtualAccountNumber": "9012345678",
"virtualAccountName": "Obiex / Acme Corp",
"virtualBankName": "Providus Bank",
"virtualAccountReference": "INV-REF-2026-001",
"accountExpiresAt": "2026-06-10T11:30:00.000Z",
"trackingId": "TRK-20260610-001",
"beneficiaryAccountNumber": "12345678901",
"beneficiaryAccountName": "Acme Corp Account",
"beneficiaryBankName": "First International Bank",
"beneficiaryBankCountry": "US",
"beneficiaryBankAddress": "123 Main Street, New York, NY 10001",
"beneficiaryName": "Acme Corp",
"beneficiaryAddress": "456 Business Ave, San Francisco, CA 94105",
"beneficiaryCountryCode": "US",
"beneficiaryCountryOfResidence": "United States",
"swiftCode": "FIBKUS33XXX"
}
}Invoice Settlement
Get invoice
Retrieve a single invoice by its ID.
GET
/
invoices
/
{invoiceId}
Get invoice
curl --request GET \
--url https://api.obiex.finance/v1/invoices/{invoiceId} \
--header 'x-api-key: <api-key>'import requests
url = "https://api.obiex.finance/v1/invoices/{invoiceId}"
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.obiex.finance/v1/invoices/{invoiceId}', 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.obiex.finance/v1/invoices/{invoiceId}",
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.obiex.finance/v1/invoices/{invoiceId}"
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.obiex.finance/v1/invoices/{invoiceId}")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.obiex.finance/v1/invoices/{invoiceId}")
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{
"message": "Ok",
"data": {
"id": "a3f1c2d4-8b0e-4f3a-9c7d-1e2b3a4c5d6e",
"createdAt": "2026-06-10T11:00:00.000Z",
"updatedAt": "2026-06-10T12:45:00.000Z",
"status": "COMPLETED",
"sourceCurrency": "NGN",
"sourceAmount": 1625000,
"targetCurrency": "USD",
"targetAmount": 1000,
"rate": 1625,
"purposeOfPayment": "Payment for software development services",
"invoiceDocument": "https://res.cloudinary.com/afrivelle/image/upload/v1718000000/invoice_abc123.pdf",
"virtualAccountNumber": "9012345678",
"virtualAccountName": "Obiex / Acme Corp",
"virtualBankName": "Providus Bank",
"virtualAccountReference": "INV-REF-2026-001",
"accountExpiresAt": "2026-06-10T11:30:00.000Z",
"trackingId": "TRK-20260610-001",
"beneficiaryAccountNumber": "12345678901",
"beneficiaryAccountName": "Acme Corp Account",
"beneficiaryBankName": "First International Bank",
"beneficiaryBankCountry": "US",
"beneficiaryBankAddress": "123 Main Street, New York, NY 10001",
"beneficiaryName": "Acme Corp",
"beneficiaryAddress": "456 Business Ave, San Francisco, CA 94105",
"beneficiaryCountryCode": "US",
"beneficiaryCountryOfResidence": "United States",
"swiftCode": "FIBKUS33XXX"
}
}Was this page helpful?
⌘I