Skip to main content
GET
/
payment-request
Get Payment Requests
curl --request GET \
  --url https://api.royalti.io/payment-request/ \
  --header 'Authorization: Bearer <token>'
{
  "status": "success",
  "message": "Payment Requests retrieved successfully",
  "response": {
    "totalItems": 11,
    "PaymentRequests": [
      {
        "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
          }
        }
      }
    ],
    "totalPages": 2,
    "currentPage": 1,
    "filteredItems": 10
  }
}
This endpoint requires authentication. Include your Bearer token in the Authorization header.

​
Description

Get Payment Requests Description:
The /payment-request/ endpoint retrieves a list of payment requests with filtering and pagination options. Method:
GET Query Parameters:
ParameterTypeDescription
q (Optional)stringSearch query to filter payment requests
page (Optional)integerPage number for pagination. Default: 1
size (Optional)integerNumber of requests per page. Default: 10
user (Optional)stringFilter by user ID

​
Code Examples

const response = await fetch('https://api.royalti.io/payment-request/', {
  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}"

Query Parameters

​
q
string

Search query to filter payment requests

​
page
integer
default:1

Page number for pagination

​
size
integer
default:10

Number of requests per page

​
user
string

Filter by user ID

Response

Success

​
message
string
​
paymentRequests
object[]
​
total
integer
​
page
integer
​
size
integer