Query Payment

Overview

Query the status and details of a previous payment using either the system-assigned order_id or your partner_order_id.

Resource Access

• HTTP Method: GET
• Endpoint: /banking/iban/api/payout/v2/query
• Authentication: Bearer token required

Query Parameters

Parameter	Type	Required	Description
order_id	string	Conditional	The unique payment order ID assigned by the system
partner_order_id	string	Conditional	The unique payment request ID from your system

Note: At least one of order_id or partner_order_id must be provided.

Request Headers

Header	Value	Required	Description
Accept	application/json	Yes	Content type for the response
Authorization	Bearer {access_token}	Yes	Bearer token for authentication
on-behalf-of	string	No	Customer ID for on-behalf-of operations

Response

Success Response (200 OK)

{
  "order_id": "202501092053115499258",
  "partner_order_id": "2024834713M3STH",
  "status": "COMPLETED",
  "biz_id": "VA202501142006502111",
  "payout_type": "PAYOUT",
  "origin_currency": "USD",
  "origin_amount": 100.00,
  "target_currency": "INR",
  "target_amount": 123.45,
  "exchange_rate": 83.25,
  "fee": 5.00,
  "to_account_id": "R202412311029369694",
  "reference": "Invoice payment",
  "clearing_network": "SWIFT",
  "fee_bear": "OUR",
  "created_at": "2026-01-14T10:00:00.000Z",
  "completed_at": "2026-01-15T10:00:00.000Z",
  "status_history": [
    {
      "status": "PROCESSING",
      "timestamp": "2026-01-14T10:00:00.000Z"
    },
    {
      "status": "COMPLETED",
      "timestamp": "2026-01-15T10:00:00.000Z"
    }
  ]
}

Response Fields

Field	Type	Description
order_id	string	System payment order ID
partner_order_id	string	Your payment identifier
status	string	Current payment status
biz_id	string	Virtual account ID
payout_type	string	Type of payout
origin_currency	string	Source currency
origin_amount	number	Amount debited
target_currency	string	Destination currency
target_amount	number	Amount credited
exchange_rate	number	Applied exchange rate
fee	number	Transaction fee
to_account_id	string	Recipient account ID
reference	string	Payment reference
clearing_network	string	Clearing network used
fee_bear	string	Fee bearer
created_at	string (date-time)	Creation timestamp
completed_at	string (date-time)	Completion timestamp
status_history	array	Payment status history

Payment Status Values

• PROCESSING: Payment submitted and being processed
• COMPLETED: Payment successfully delivered
• FAILED: Payment failed
• CANCELLED: Payment cancelled

Error Responses

• 401 Unauthorized: Invalid or missing authentication token
• 404 Not Found: Payment not found

Code Examples

cURL

curl -X GET \
  'https://gateway.ahrvo.network/banking/iban/api/payout/v2/query?order_id=202501092053115499258&partner_order_id=2024834713M3STH' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Python

import requests

url = "https://gateway.ahrvo.network/banking/iban/api/payout/v2/query"
headers = {
    "Accept": "application/json",
    "Authorization": "Bearer YOUR_ACCESS_TOKEN"
}
params = {
    "order_id": "202501092053115499258",
    "partner_order_id": "2024834713M3STH"
}

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

JavaScript (Node.js)

const axios = require('axios');

const url = 'https://gateway.ahrvo.network/banking/iban/api/payout/v2/query';
const headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer YOUR_ACCESS_TOKEN'
};
const params = {
  order_id: '202501092053115499258',
  partner_order_id: '2024834713M3STH'
};

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

Usage Notes

• Use webhooks for real-time status updates instead of polling
• Both order_id and partner_order_id can be provided for validation
• Status history shows the progression of the payment
• Failed payments include failure reason in the response
• Completed payments show the actual completion timestamp

Interactive API Explorer