Get all Payment Requests (Legacy)

Overview

This service is used to get the list of all payment withdrawal requests for a user, including amount, reference, state, currency, and recipient account details.

Resource Access

• HTTP Method: GET
• Endpoint: /profile/v2.1/request
• Authentication: Bearer token required

Request Headers

Header	Value	Required	Description
Accept	application/json	Yes	Content type for the response
Authorization	Bearer {access_token}	Yes	Bearer token for authentication
x-api-key	string	No	API key for additional authentication

Query Parameters

Parameter	Type	Required	Description
pageSize	integer	No	Number of records per page (default: 10).
page	integer	No	Page number to retrieve (default: 1).
search	string	No	Search query string to filter by reference or account details.

Response

Success Response (200 OK)

{
  "success": true,
  "data": [
    {
      "id": 5424,
      "amount": "788888.00",
      "reference": "TO-19062024-002",
      "state": "completed",
      "currency": "NGN",
      "type": "wallet_to_account",
      "clientReference": null,
      "walletId": 2561
    }
  ],
  "metadata": {
    "total": 26,
    "currentPage": 1,
    "pageSize": 10
  }
}

Response Fields

Field	Type	Description
success	boolean	Flag indicating whether list retrieval was successful.
data	array	List of payment request objects.
data[].id	number	Unique payment ID.
data[].amount	string	Payment amount.
data[].reference	string	Payment reference.
data[].state	string	Payment state (requested, completed, failed).
data[].currency	string	Currency of the payout.

Error Responses

• 400 Bad Request: Invalid parameters or malformed request
• 401 Unauthorized: Missing or invalid Bearer authentication token
• 403 Forbidden: Insufficient account permissions
• 404 Not Found: Resource not found
• 500 Internal Server Error: An internal server error occurred

Code Examples

Base URL

Production: https://api.ahrvo.network
Staging:    https://gateway.ahrvo.network

cURL

curl -X GET \
  'https://gateway.ahrvo.network/banking/ibans/v2/profile/v2.1/request?pageSize=10&page=1' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Python

import requests

url = "https://gateway.ahrvo.network/banking/ibans/v2/profile/v2.1/request"
params = {"pageSize": 10, "page": 1}
headers = {
    "Accept": "application/json",
    "Authorization": "Bearer YOUR_ACCESS_TOKEN"
}

response = requests.get(url, params=params, headers=headers)
print(response.json())

JavaScript (Node.js)

const axios = require('axios');

const url = 'https://gateway.ahrvo.network/banking/ibans/v2/profile/v2.1/request';
const headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer YOUR_ACCESS_TOKEN'
};
const params = { pageSize: 10, page: 1 };

axios.get(url, { headers, params })
  .then(response => console.log(response.data))
  .catch(error => console.error(error.response ? error.response.data : error.message));

Usage Notes

• Use the search parameter to quickly filter transactions by reference or name.

Interactive API Explorer