Transaction Status Re-Query
curl --request GET \
--url https://payout-staging.embedly.ng/api/Payout/status/{transactionRef} \
--header 'x-api-key: <api-key>'import requests
url = "https://payout-staging.embedly.ng/api/Payout/status/{transactionRef}"
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://payout-staging.embedly.ng/api/Payout/status/{transactionRef}', 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://payout-staging.embedly.ng/api/Payout/status/{transactionRef}",
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://payout-staging.embedly.ng/api/Payout/status/{transactionRef}"
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://payout-staging.embedly.ng/api/Payout/status/{transactionRef}")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://payout-staging.embedly.ng/api/Payout/status/{transactionRef}")
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{
"data": {
"status": "Pending",
"transactionReference": "EMBEDLY-IB-12-1765129847157"
},
"statusCode": 200,
"code": null,
"message": "Successfully retrieved transaction",
"succeeded": true
}
Payout
Transaction Status Re-Query
Endpoint for re-querying the status of an inter-bank transaction using its transaction reference.
GET
/
api
/
Payout
/
status
/
{transactionRef}
Transaction Status Re-Query
curl --request GET \
--url https://payout-staging.embedly.ng/api/Payout/status/{transactionRef} \
--header 'x-api-key: <api-key>'import requests
url = "https://payout-staging.embedly.ng/api/Payout/status/{transactionRef}"
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://payout-staging.embedly.ng/api/Payout/status/{transactionRef}', 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://payout-staging.embedly.ng/api/Payout/status/{transactionRef}",
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://payout-staging.embedly.ng/api/Payout/status/{transactionRef}"
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://payout-staging.embedly.ng/api/Payout/status/{transactionRef}")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://payout-staging.embedly.ng/api/Payout/status/{transactionRef}")
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{
"data": {
"status": "Pending",
"transactionReference": "EMBEDLY-IB-12-1765129847157"
},
"statusCode": 200,
"code": null,
"message": "Successfully retrieved transaction",
"succeeded": true
}
Payout Status Definitions
The system defines the following primary status states for your transactions:| Status | Description | When It Occurs |
|---|---|---|
| CREATED | Initial status when payout record is created | After successful validation and payout initialization |
| DEBIT_INITIATED | Wallet debit process has started | When the system begins debiting the source wallet |
| DEBIT_SUCCESS | Wallet debit completed successfully | After successful withdrawal from the source wallet |
| TRANSFER_INITIATED | External transfer process has started | When the system begins the actual money transfer |
| TRANSFER_PROCESSED | Transfer has been sent to NIBBS for processing | After successful submission to payment gateway |
| SUCCESS | Payout completed successfully | Final success state after all processes complete |
| FAILED | Payout failed at any stage | When any critical error occurs during the process |
string
required
The unique reference number of the transaction whose status you want to check.
Exmaple:
3212-1234-5678-9101{
"data": {
"status": "Pending",
"transactionReference": "EMBEDLY-IB-12-1765129847157"
},
"statusCode": 200,
"code": null,
"message": "Successfully retrieved transaction",
"succeeded": true
}
⌘I