Get Payment Request
curl --request GET \
--url https://api.royalti.io/payment-request/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.royalti.io/payment-request/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.royalti.io/payment-request/{id}', 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.royalti.io/payment-request/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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.royalti.io/payment-request/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
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.royalti.io/payment-request/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.royalti.io/payment-request/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"status": "success",
"message": "Payment Request retrieved successfully",
"result": {
"TenantId": 2,
"id": "818e7125-9981-44c2-9cdf-b8b07c58b6ed",
"TenantUserId": "df474f6c-4560-49f9-bf67-d2402258eb4c",
"PaymentSettingId": "9fe3d6d2-c309-4ffd-ba35-d889b91dfaba",
"currency": "NGN",
"amount": 150000,
"amountUSD": 100,
"memo": "trf",
"status": "pending",
"createdAt": "2024-12-12T07:36:23.190Z",
"updatedAt": "2024-12-12T07:36:23.190Z",
"TenantUser": {
"id": "df474f6c-4560-49f9-bf67-d2402258eb4c",
"firstName": "Omah",
"lastName": "Stanley",
"User": {
"email": "itzdatcoolzee@gmail.com",
"profilePicture": null
}
}
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>",
"details": [
"<string>"
]
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>",
"details": [
"<string>"
]
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>",
"details": [
"<string>"
]
}
}Payment Requests
Get Payment Request
Get Payment Request
GET
/
payment-request
/
{id}
Get Payment Request
curl --request GET \
--url https://api.royalti.io/payment-request/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.royalti.io/payment-request/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.royalti.io/payment-request/{id}', 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.royalti.io/payment-request/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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.royalti.io/payment-request/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
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.royalti.io/payment-request/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.royalti.io/payment-request/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"status": "success",
"message": "Payment Request retrieved successfully",
"result": {
"TenantId": 2,
"id": "818e7125-9981-44c2-9cdf-b8b07c58b6ed",
"TenantUserId": "df474f6c-4560-49f9-bf67-d2402258eb4c",
"PaymentSettingId": "9fe3d6d2-c309-4ffd-ba35-d889b91dfaba",
"currency": "NGN",
"amount": 150000,
"amountUSD": 100,
"memo": "trf",
"status": "pending",
"createdAt": "2024-12-12T07:36:23.190Z",
"updatedAt": "2024-12-12T07:36:23.190Z",
"TenantUser": {
"id": "df474f6c-4560-49f9-bf67-d2402258eb4c",
"firstName": "Omah",
"lastName": "Stanley",
"User": {
"email": "itzdatcoolzee@gmail.com",
"profilePicture": null
}
}
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>",
"details": [
"<string>"
]
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>",
"details": [
"<string>"
]
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>",
"details": [
"<string>"
]
}
}This endpoint requires authentication. Include your Bearer token in the Authorization header.
Description
Get Payment Request Description:The
/payment-request/{id} endpoint retrieves details of a specific payment request by its ID.
Authorization:
- Required role:
useror higher
GET
Path Parameter:
| Parameter | Type | Description |
|---|---|---|
| id | string | The unique identifier of the payment request |
Code Examples
const response = await fetch('https://api.royalti.io/payment-request/example-id', {
method: 'GET',
headers: {
'Authorization': `Bearer ${token}`,
},
});
const data = await response.json();
console.log(data);
import requests
response = requests.get(
'https://api.royalti.io/payment-request/example-id',
headers={
'Authorization': f'Bearer {token}'
},
)
data = response.json()
print(data)
curl -X GET https://api.royalti.io/payment-request/example-id \
-H "Authorization: Bearer YOUR_TOKEN" \
⌘I