HEhevn-inc
virtual accounts

Retrieve one virtual account

Retrieve the receiving account of one region product and, when opened, its receiving details. The product is the path key.

get/banks/{product}

Request

Path parameters

product'us' | 'swift' | 'eu' | 'uae' | 'uk' | 'br' | 'mx' | 'co' | 'ar' | 'au' | 'ng' | 'ca' | 'dk' | 'no' | 'pl' | 'tr' | 'il' | 'sa' | 'bo' | 'cl' | 'cr' | 'do' | 'gt' | 'hn' | 'jm' | 'eg' | 'sl' | 'tz' | 'ug' | 'waemu' | 'zm' | 'bd' | 'cn' | 'hk' | 'in' | 'id' | 'jp' | 'my' | 'pk' | 'ph' | 'kr' | 'th' | 'vn' | 'card' required

Region product, for example eu or us

Headers

X-Hevn-Accountstring nullable

The client account to act for, as a cl_… id. Omit it to act as yourself.

Example:cl_9f2c1ab84d7e4f1fa3c65b0e7d9a2c41

Response

Successful Response

product'us' | 'swift' | 'eu' | 'uae' | 'uk' | 'br' | 'mx' | 'co' | 'ar' | 'au' | 'ng' | 'ca' | 'dk' | 'no' | 'pl' | 'tr' | 'il' | 'sa' | 'bo' | 'cl' | 'cr' | 'do' | 'gt' | 'hn' | 'jm' | 'eg' | 'sl' | 'tz' | 'ug' | 'waemu' | 'zm' | 'bd' | 'cn' | 'hk' | 'in' | 'id' | 'jp' | 'my' | 'pk' | 'ph' | 'kr' | 'th' | 'vn' | 'card' required
railstring required

Rail serving this product. Informational; address the account by product.

currencystring required

ISO 4217 fiat currency code received through this payment method.

railCurrency'USD' | 'EUR' | 'USDC' | 'EURC' | 'RD' | 'USDC_ARB' required

The asset credited when money arrives through a bank rail.

method'sepa' | 'swift' | 'ach' | 'uaefts' | 'fedwire' | 'rtp' | 'fednow' | 'pix' | 'spei' | 'pse' | 'breb' | 'transfers_3_0' | 'ukfps' | 'npp' | 'nip' | 'bdt_local' | 'bdt_ewallet' | 'bob_local' | 'brl_local' | 'cad_eft' | 'clp_local' | 'cny_alipay' | 'cny_wechatpay' | 'cop_local' | 'crc_local' | 'dkk_local' | 'dop_local' | 'dop_ewallet' | 'egp_local' | 'gtq_local' | 'gtq_ewallet' | 'hkd_fps' | 'hnl_local' | 'idr_local' | 'idr_ewallet' | 'ils_local' | 'inr_local' | 'inr_upi' | 'jmd_local' | 'jpy_local' | 'krw_local' | 'myr_local' | 'nok_local' | 'php_local' | 'php_ewallet' | 'pkr_raast' | 'pkr_ewallet' | 'pln_local' | 'sar_local' | 'sle_local' | 'thb_local' | 'try_fast' | 'tzs_local' | 'ugx_local' | 'vnd_local' | 'xof_local' | 'zmw_local' required
openedboolean required

Whether receiving details have been provisioned for this payment method.

status'preparing' | 'active' | 'suspended' | 'closed'
feeBpsinteger required

Variable fee in basis points; 100 basis points equals 1 percent.

supportedAccountsAccountKey[] required

Accounts this payment method can settle to.

destinationAccount'USDC' | 'EURC' | 'RD' | 'USDC_ARB' | 'FDIC_USD' | 'FDIC_EUR' | 'KYC_CARDS'
minimumDepositstring nullable

Minimum amount accepted through this method.

idstring nullable

Opened virtual-account identifier.

Example response

{
  "minimumDeposit": "500.00",
  "id": "bnk_9f2c1ab84d7e4f1fa3c65b0e7d9a2c41"
}

Changes

No recorded changes to this operation across all 17 revisions of this API.