Skip to main content

Global Banking Legacy APIs - Overview

Introduction​

The Global Banking Legacy APIs provide comprehensive coverage for cross-border payment operations, multi-currency wallets, foreign exchange conversions, beneficiary management, and withdrawal payment requests across developed and emerging markets.

Features​

  • Foreign Exchange (FX): Real-time FX rate quotation with short-lived tokens and order execution for currency conversions
  • Beneficiary Management: Create, view, update, and delete individual, company, or mobile money beneficiaries
  • Multi-Currency Wallets: View available balances, currency holdings, and wallet-specific details
  • Withdrawal Payment Requests: Dispatch wallet-to-account payouts with optional compliance document attachments
  • Payment Verification: Retrieve official proofs of payment (POP) for completed transactions
  • System Listings: Access supported currencies and regulatory purpose codes

Authentication​

All API requests require authentication using a Bearer token in the Authorization header.

Authorization: Bearer <your_access_token>

Optional x-api-key header may also be supplied where required by your staging or production tenant.

Base URLs​

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

Common Headers​

HeaderValueRequiredDescription
AuthorizationBearer {token}YesJWT Bearer access token
Content-Typeapplication/jsonYesRequest content type (for POST/PUT)
Acceptapplication/jsonYesResponse content type
x-api-keystringNoOptional API key for merchant routing

Service Categories & Endpoints​

1. Payment Transactions​

  • Retrieve Proof of Payment (GET /banking/ibans/v2/profile/transaction-history/proof-of-payment/{reference}) - Retrieve proof of payment documentation.

2. FX Service​

  • Get an FX Rate (GET /banking/ibans/v2/orders/v2.1/fx) - Retrieve a real-time exchange quote and a 30-second token.
  • Create an FX Trade (POST /banking/ibans/v2/orders/v2.1/fx) - Execute a currency conversion trade.
  • Get an FX Trade (GET /banking/ibans/v2/orders/v2.1/fx/{orderId}) - Retrieve status and details for an FX trade.

3. Beneficiary Service​

  • Create a Beneficiary (POST /banking/ibans/v2/profile/v2.1/beneficiaries) - Add a new beneficiary.
  • Get all Beneficiaries (GET /banking/ibans/v2/profile/v2.1/beneficiaries) - List registered beneficiaries.
  • Get a Beneficiary (GET /banking/ibans/v2/profile/v2.1/beneficiaries/{beneficiaryId}) - Fetch beneficiary details.
  • Update a Beneficiary (PUT /banking/ibans/v2/profile/v2.1/beneficiaries/{beneficiaryId}) - Update beneficiary information.
  • Delete a Beneficiary (DELETE /banking/ibans/v2/profile/v2.1/beneficiaries/{beneficiaryId}) - Remove a beneficiary.

4. Wallet Service​

  • Get all Wallets (GET /banking/ibans/v2/profile/v2.2/wallets) - Fetch all multi-currency wallets.
  • Get a Wallet (GET /banking/ibans/v2/profile/v2.2/wallets/{wallet_id}) - Fetch balance and details for a specific wallet.

5. Listing Service​

  • Get all Purpose Codes (GET /banking/ibans/v2/profile/v2.1/purpose) - List regulatory purpose codes.
  • Get all Currencies (GET /banking/ibans/v2/profile/v2.1/currencies) - List supported payout currencies.

6. Withdrawal Service​

Workflow Overview​

graph TD
    A["Check Wallet Balances (Get all Wallets)"] --> B["Get Live FX Rate (30s vfx_token)"]
    B --> C["Execute FX Trade (Convert Funds)"]
    C --> D["Register / Verify Beneficiary"]
    D --> E["Lookup Purpose Code"]
    E --> F["Create Payment Request (Withdrawal)"]
    F --> G["Track Status & Download Proof of Payment"]

Support​

For technical assistance and onboarding support, contact the integration support team at support@ahrvo.com.