Get a Payment Request (Legacy)
Overview
This service is used to retrieve details of a specific payment request by requestID, including payout amount, transaction state, timestamp, and recipient beneficiary details.
Resource Access
- HTTP Method:
GET - Endpoint:
/profile/v2.1/request/{requestID} - 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 |
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
requestID | number | Yes | The unique ID of the payment withdrawal request (e.g. 416). |
Response
Success Response (200 OK)
{
"success": true,
"data": {
"id": 416,
"amount": "100.00",
"reference": "TO-16062022-007",
"state": "completed",
"currency": "INR",
"clientReference": "Payment-100",
"account": {
"id": 284,
"accountNumber": "2000293918130",
"bankName": "PUNJAB NATIONAL BANK",
"beneficiaryFirstName": "Jon",
"beneficiaryLastName": "Doe",
"currency": "INR"
}
}
}
Response Fields
| Field | Type | Description |
|---|---|---|
success | boolean | Flag indicating whether request lookup was successful. |
data.id | number | Payment ID. |
data.amount | string | Payment amount. |
data.reference | string | Unique reference code. |
data.state | string | Current execution state. |
data.currency | string | Payout currency. |
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/416' \
-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/416"
headers = {
"Accept": "application/json",
"Authorization": "Bearer YOUR_ACCESS_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())
JavaScript (Node.js)
const axios = require('axios');
const requestId = 416;
const url = `https://gateway.ahrvo.network/banking/ibans/v2/profile/v2.1/request/${requestId}`;
const headers = {
'Accept': 'application/json',
'Authorization': 'Bearer YOUR_ACCESS_TOKEN'
};
axios.get(url, { headers })
.then(response => console.log(response.data))
.catch(error => console.error(error.response ? error.response.data : error.message));
Usage Notes
- Use this endpoint to query individual status changes for a transaction.