cURL
curl --request GET \
--url https://api.paycashless.com/v1/payouts/verify/{reference} \
--header 'Request-Signature: <request-signature>' \
--header 'Request-Timestamp: <request-timestamp>'import requests
url = "https://api.paycashless.com/v1/payouts/verify/{reference}"
headers = {
"Request-Signature": "<request-signature>",
"Request-Timestamp": "<request-timestamp>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {
'Request-Signature': '<request-signature>',
'Request-Timestamp': '<request-timestamp>'
}
};
fetch('https://api.paycashless.com/v1/payouts/verify/{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.paycashless.com/v1/payouts/verify/{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 => [
"Request-Signature: <request-signature>",
"Request-Timestamp: <request-timestamp>"
],
]);
$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.paycashless.com/v1/payouts/verify/{reference}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Request-Signature", "<request-signature>")
req.Header.Add("Request-Timestamp", "<request-timestamp>")
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.paycashless.com/v1/payouts/verify/{reference}")
.header("Request-Signature", "<request-signature>")
.header("Request-Timestamp", "<request-timestamp>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.paycashless.com/v1/payouts/verify/{reference}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Request-Signature"] = '<request-signature>'
request["Request-Timestamp"] = '<request-timestamp>'
response = http.request(request)
puts response.read_body{
"id": "<string>",
"reference": "<string>",
"amount": 123,
"currency": "NGN",
"status": "pending",
"destinationAccountNumber": "<string>",
"destinationBankId": "<string>",
"fee": 123,
"vat": 123,
"networkSessionId": "<string>",
"requiresConfirmation": true,
"confirmationState": "pending",
"callbackUrl": "<string>",
"receiptEmail": "<string>",
"narration": "<string>",
"metadata": {},
"failureCode": "<string>",
"failureMessage": "<string>",
"liveMode": true,
"initiation": {
"actor": "user",
"ip": "<string>",
"user": {
"email": "<string>"
},
"apiKey": {
"description": "<string>"
}
},
"approval": {
"approvedBy": "<string>",
"approvedAt": "2023-11-07T05:31:56Z"
},
"cancellation": {
"cancelledBy": "<string>",
"cancelledAt": "2023-11-07T05:31:56Z"
},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}Payouts
Verify payout
Retrieve a payout by reference
GET
/
v1
/
payouts
/
verify
/
{reference}
cURL
curl --request GET \
--url https://api.paycashless.com/v1/payouts/verify/{reference} \
--header 'Request-Signature: <request-signature>' \
--header 'Request-Timestamp: <request-timestamp>'import requests
url = "https://api.paycashless.com/v1/payouts/verify/{reference}"
headers = {
"Request-Signature": "<request-signature>",
"Request-Timestamp": "<request-timestamp>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {
'Request-Signature': '<request-signature>',
'Request-Timestamp': '<request-timestamp>'
}
};
fetch('https://api.paycashless.com/v1/payouts/verify/{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.paycashless.com/v1/payouts/verify/{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 => [
"Request-Signature: <request-signature>",
"Request-Timestamp: <request-timestamp>"
],
]);
$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.paycashless.com/v1/payouts/verify/{reference}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Request-Signature", "<request-signature>")
req.Header.Add("Request-Timestamp", "<request-timestamp>")
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.paycashless.com/v1/payouts/verify/{reference}")
.header("Request-Signature", "<request-signature>")
.header("Request-Timestamp", "<request-timestamp>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.paycashless.com/v1/payouts/verify/{reference}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Request-Signature"] = '<request-signature>'
request["Request-Timestamp"] = '<request-timestamp>'
response = http.request(request)
puts response.read_body{
"id": "<string>",
"reference": "<string>",
"amount": 123,
"currency": "NGN",
"status": "pending",
"destinationAccountNumber": "<string>",
"destinationBankId": "<string>",
"fee": 123,
"vat": 123,
"networkSessionId": "<string>",
"requiresConfirmation": true,
"confirmationState": "pending",
"callbackUrl": "<string>",
"receiptEmail": "<string>",
"narration": "<string>",
"metadata": {},
"failureCode": "<string>",
"failureMessage": "<string>",
"liveMode": true,
"initiation": {
"actor": "user",
"ip": "<string>",
"user": {
"email": "<string>"
},
"apiKey": {
"description": "<string>"
}
},
"approval": {
"approvedBy": "<string>",
"approvedAt": "2023-11-07T05:31:56Z"
},
"cancellation": {
"cancelledBy": "<string>",
"cancelledAt": "2023-11-07T05:31:56Z"
},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}Headers
SHA-512 HMAC signature of the request payload using the API secret
Minimum string length:
1Example:
"5e73d044c44d733fcf819ad3409aaaddca840d421b69cb0b04e2c750fc62ece7526d36296237663ad1f06f62a730c0466516507196b3ce6567493cc52a7cf63d"
UNIX timestamp when the request was created (in seconds)
Pattern:
^\d{10}$Example:
"1712336881"
Path Parameters
The reference of the payout to verify
Response
200 - application/json
Payout retrieved by reference
Available options:
NGN, USD Available options:
pending, succeeded, failed, reversed, sent, cancelled Available options:
pending, confirmed, rejected Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes