Retrieve Payment Details (Atlas)

Overview

The GET /banking/ibans/v2/payments/{paymentId} endpoint retrieves the comprehensive record of a payment using its unique internal UUID (paymentId).

It returns complete details regarding execution state, amounts, source wallet, destination beneficiary account, purpose of payment, pricing overages, and underlying transaction information.

Resource Access

• HTTP Method: GET
• Endpoint: /banking/ibans/v2/payments/{paymentId}
• Authentication: Bearer token required
• Permissions: Admin:Exchange Now:read, Client:At Desired Rate:read, Admin:Exchange Later:read

Request Headers

Header	Value	Required	Description
Authorization	Bearer {access_token}	Yes	JWT Bearer access token
Accept	application/json	Yes	Response payload format

Path Parameters

Parameter	Type	Required	Description	Example
paymentId	string	Yes	Unique payment identifier (UUID).	ee7e9602-4dd2-4d02-ae55-bfc527c913ef

---

Response

Success Response (200 OK)

{
  "reference": "TO-29072023-114",
  "paymentId": "807e02f5-7235-4826-aef5-d93c75216b48",
  "amount": 500.0,
  "currency": "USD",
  "userRecordId": 2669,
  "walletId": 12582,
  "state": "completed",
  "type": "credit",
  "target": "account",
  "targetId": 21688,
  "purpose": "Purchase of Professional Service(s)",
  "description": null,
  "pricing": {
    "overageFee": 0,
    "usageId": null,
    "subscriptionId": null
  },
  "tracking": {},
  "transaction": {
    "sender": {},
    "receiver": {}
  }
}

Response Fields

Field	Type	Description
reference	string	Unique human-readable payment reference (e.g. TO-29072023-114).
paymentId	string	UUID identifier of the payment.
amount	number	Payment amount.
currency	string	ISO currency code.
userRecordId	integer	Identifier of the user who submitted the request.
walletId	integer	Associated funding wallet ID.
state	string	Current lifecycle state (e.g. completed, REQUESTED).
type	string	Transaction direction (e.g. credit or debit).
target	string	Target entity type (account or wallet).
targetId	integer	Destination beneficiary account ID or wallet ID.
purpose	string	Compliance payment purpose description.
description	string	Customer-provided memo.
pricing	object	Overage fee, usage ID, and subscription details.
tracking	object	Clearing tracking metadata.
transaction	object	Underlying sender and receiver bank ledger records.

---

Error Codes

Status Code	Description	Reason
400 Bad Request	Invalid input	Malformed paymentId parameter.
401 Unauthorized	Authentication failure	Missing or expired Bearer token.
403 Forbidden	Access denied	User does not have permission or payment belongs to another company.
404 Not Found	Payment not found	No record exists for the given paymentId.
500 Server Error	Internal failure	Server-side execution issue.

---

Code Examples

cURL

curl -X GET "https://api.ahrvo.network/banking/ibans/v2/payments/ee7e9602-4dd2-4d02-ae55-bfc527c913ef" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Accept: application/json"

JavaScript (Fetch)

const paymentId = 'ee7e9602-4dd2-4d02-ae55-bfc527c913ef';
const response = await fetch(`https://api.ahrvo.network/banking/ibans/v2/payments/${paymentId}`, {
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Accept': 'application/json'
  }
});

const payment = await response.json();
console.log('Payment State:', payment.state, 'Amount:', payment.amount, payment.currency);

Python (requests)

import requests

payment_id = "ee7e9602-4dd2-4d02-ae55-bfc527c913ef"
url = f"https://api.ahrvo.network/banking/ibans/v2/payments/{payment_id}"
headers = {
    "Authorization": "Bearer YOUR_ACCESS_TOKEN",
    "Accept": "application/json"
}

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

---

Interactive API Console

Test the endpoint directly in your browser: