Skip to main content

Get an FX Trade (New)

Overview

Retrieves the complete state, pricing breakdown, and settlement details of an FX conversion trade using its canonical alphanumeric reference (e.g. EN-05062024-055).

HTTP Request

GET /banking/ibans/v2/fx/{reference}

Authentication

This endpoint requires an active Bearer JWT token in the Authorization header obtained via POST /banking/ibans/v2/users/login:

Authorization: Bearer <your_access_token>

Path Parameters

ParameterTypeRequiredDescription
referencestringYesCanonical transaction reference of the FX trade (e.g. EN-05062024-055)

Code Examples

curl -X GET "https://api.ahrvo.network/banking/ibans/v2/fx/{reference}" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer <your_access_token>"

Response (200)

{
"id": "20088",
"reference": "EN-05062024-055",
"userId": "2289",
"companyId": "2233",
"currencyFrom": "USD",
"amountFrom": 4800,
"currencyTo": "NGN",
"amountTo": 4936560,
"rate": 1028.4456,
"pricing": {
"overageFee": 0,
"usageId": "6660409cc733e0fac55eb97f",
"subscriptionId": "664b3fc0e8e52032427e0b70"
},
"state": "inwardSettlementDone",
"source": "wallet",
"sourceId": 11435,
"target": "account",
"targetId": 32655,
"description": null,
"inwardSettlementTime": "2024-06-05T10:40:44.000Z",
"outwardSettlementTime": null,
"purpose": "Professional fees payment(i.e. legal, accountant)",
"scheduledAt": null,
"expiredAt": null,
"createdAt": "2024-06-05T10:40:29.000Z",
"updatedAt": "2024-06-05T10:40:51.000Z",
"transaction": {
"receiver": {
"accountNumber": "5401662301",
"bankName": "Providus Bank",
"name": "crest ",
"bankCode": "000023"
},
"shortURL": "https://pay.vertofx.com/n3hjz2v"
},
"paymentId": "88ba34cd-7074-46f4-a006-4fd8c7a5e1e8"
}

Interactive API Explorer

Test this endpoint live against the Ahrvo gateway and Verto sandbox environments: