Skip to main content
GET
/
payment-request
/
{id}
Get Payment Request
curl --request GET \
  --url https://api.royalti.io/payment-request/{id} \
  --header 'Authorization: Bearer <token>'
{
  "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": "[email protected]",
        "profilePicture": null
      }
    }
  }
}
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. Method:
GET Path Parameter:
ParameterTypeDescription
idstringThe 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);

Authorizations

​
Authorization
string
header
required

JWT Authorization header using the Bearer scheme. Format: "Bearer {token}"

Path Parameters

​
id
string
required

Payment Request ID

Response

Success

​
message
string
​
paymentRequest
object