HEhevn-inc
virtual accounts

Request a receiving account for a product

Changed on

Answers 201 with the account record the first time, 200 with Idempotency-Replayed: true when the product was already requested or is already active. A receiving account is a singleton per client and product, so the server key is the client and the product. Unmet prerequisites never refuse the request: the record stays preparing and lists its blockers.

post/banks

Request

Headers

Idempotency-Keystring nullable

Your own key for this write, ^[A-Za-z0-9._:-]{1,128}$. A retry with the same key replays the first answer; the same key with a different request is refused.

Example:po-inv-2026-114
X-Hevn-Accountstring nullable

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

Example:cl_9f2c1ab84d7e4f1fa3c65b0e7d9a2c41

Request body

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

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

  • 299a3aa6f521Revision changes
    • breaking

      added the new required request property

    • warning

      removed the request property

    • warning

      added the new EUR enum value to the response property for the response status

    • warning

      added the new FDIC_EUR enum value to the / response property for the response status

    • warning

      added the new FDIC_EUR enum value to the / response property for the response status

    • warning

      added the new verification_not_applicable enum value to the / response property for the response status

    • info

      added the optional property to the response with the status

    • info

      added to the /// response property anyOf list for the response status

    • info

      removed from the /// response property anyOf list for the response status

    • info

      the response property /// became required for the status

    • info

      the response property /// became required for the status

    • info

      the response property /// became required for the status

    • info

      the response property /// became required for the status

    • info

      the response property /// became required for the status

    • info

      the response property /// became required for the status

    • info

      the response property /// became required for the status

    • info

      the response property /// became required for the status

    • info

      the response property /// became required for the status

    • info

      the response property /// became required for the status

    • info

      the response property /// became required for the status

    • info

      the response property /// became required for the status

    • info

      the response property /// became required for the status

    • info

      the response property /// became required for the status

    • info

      the response property /// became required for the status

    • info

      the response property /// became required for the status

    • info

      the response property /// became required for the status

    • info

      the response property /// became required for the status

    • info

      the response property /// became required for the status

    • info

      removed the phone_required enum value from the / response property for the response status

    • info

      removed the rail_requirements_unmet enum value from the / response property for the response status

    • info

      added the required property to the response with the status

  • a02795de2d2bRevision changes
    • warning

      deleted the header request parameter x-api-key

    • warning

      added the new KYC_CARDS enum value to the / response property for the response status

    • warning

      added the new KYC_CARDS enum value to the / response property for the response status

    • warning

      added the new RD enum value to the / response property for the response status

    • warning

      added the new RD enum value to the / response property for the response status

    • warning

      added the new USDC_ARB enum value to the / response property for the response status

    • warning

      added the new USDC_ARB enum value to the / response property for the response status

    • warning

      added the new client_already_linked enum value to the / response property for the response status

    • warning

      added the new kyb_documents_processing enum value to the / response property for the response status

    • warning

      added the new link_code_expired enum value to the / response property for the response status

    • warning

      added the new link_code_invalid enum value to the / response property for the response status

    • warning

      added the new payout_not_awaiting_signature enum value to the / response property for the response status

    • warning

      added the new redirect_uri_not_allowed enum value to the / response property for the response status

    • warning

      added the new sandbox_amount_limit_exceeded enum value to the / response property for the response status

    • warning

      added the new sandbox_faucet_balance_too_high enum value to the / response property for the response status

    • info

      removed the client_policy_not_enabled enum value from the / response property for the response status

    • info

      removed the client_request_conflict enum value from the / response property for the response status

    • info

      removed the email_in_use enum value from the / response property for the response status

    • info

      removed the integrator_inactive enum value from the / response property for the response status

    • info

      removed the name_in_use enum value from the / response property for the response status

    • info

      added the required property to the response with the status