Skip to main content

VA currencies

GET
Authentication

Virtual Account APIs use the same access token as the rest of the platform. Obtain it from the Authentication API and send it on every VA call:

Authorization: Bearer <access_token>

Base URLs for each environment are listed under API environments.

note

What this does: Returns the list of settlement currencies enabled for Virtual Accounts under a given send client. Use this to know which currencies you can even open a VA in before starting onboarding.

Endpoint​

GET/ewallet/api/v1/currency/virtualAccountCurrency/{sendClientCode}
Sandboxhttps://sandbox-client.remittanceshub.com:8130/ewallet/api/v1/currency/virtualAccountCurrency/{sendClientCode}Productionhttps://prod-api.remittanceshub.com:9091/ewallet/api/v1/currency/virtualAccountCurrency/{sendClientCode}
  • Path Parameter — REQUIRED sendClientCode — your 10-digit client code

Sample Response​

{
  "resultCode": "0",                        // "0" = success, see Section 17
  "resultDescription": "Transaction successful",
  "virtualAccountSettleCurrencyList": [
    {
      "id": 4,
      "code": "100003",
      "name": "United States Dollar",
      "currencyCode": "USD-USA",
      "symbol": "$",
      "status": "Active",
      "vaSettlementFlag": true,               // must be true to be VA-eligible
      "b2b": true, "b2c": true, "c2c": true, "c2b": true, "wpt": true
    }
  ]
}

Key Response Fields​

FieldNotes
codeInternal currency code — use this value (not currencyCode) where a currency code is expected elsewhere in this API, e.g. sendClientVaAccountCurrency in VA approval process.
currencyCodeHuman/ISO-style currency string, format CCY-COUNTRY e.g. USD-USA.
vaSettlementFlagOnly currencies with true here can be used for Virtual Account settlement.
statusActive / Inactive — inactive currencies should be hidden from selection UIs.