Skip to main content

Retrieve Proof of Payments (Legacy)

Overview

This endpoint is used to get proof of payment (POP) documents for a transaction via the API. By providing the unique transaction reference, you can retrieve verification records and confirmation details confirming the presence and status of the payment.

Resource Access

  • HTTP Method: GET
  • Endpoint: /banking/ibans/v2/profile/transaction-history/proof-of-payment/{reference}
  • Authentication: Bearer token required

Request Headers

HeaderValueRequiredDescription
Acceptapplication/jsonYesContent type for the response
AuthorizationBearer {access_token}YesBearer token for authentication
x-api-keystringNoAPI key for additional authentication

Path Parameters

ParameterTypeRequiredDescription
referencestringYesA unique transaction reference used to identify the specific payment (e.g. T0-28052024-046).

Response

Success Response (200 OK)

{
"success": true,
"result": {
"pop": "https://storage.ahrvo.network/pop/T0-28052024-046.pdf",
"type": "Faster Payments Proof of Payment"
}
}

Response Fields

FieldTypeDescription
successbooleanIndicates whether the proof of payment was successfully retrieved.
resultobjectContains detailed information about the proof of payment.
result.popstringURL or data content of the proof of payment for the transaction.
result.typestringThe name/scheme of the proof of payment (e.g., SEPA, Faster Payments, SWIFT).

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/transaction-history/proof-of-payment/T0-28052024-046' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Python

import requests

url = "https://gateway.ahrvo.network/banking/ibans/v2/profile/transaction-history/proof-of-payment/T0-28052024-046"
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 reference = 'T0-28052024-046';
const url = `https://gateway.ahrvo.network/banking/ibans/v2/profile/transaction-history/proof-of-payment/${reference}`;
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

  • The reference parameter is generated during initial transaction creation.
  • A return value of success: true confirms that a valid record exists for the given reference.
  • Proofs of payment are typically available shortly after outward settlement is completed.

Interactive API Explorer