HEhevn-inc
transfers

Create an incoming transfer quote

Changed on

Price money arriving for this account. Set originChainId for an on-chain transfer or rail for a local payment method; exactly one is required. An unsupported route answers payin_not_available.

post/payins

Request

Headers

X-Hevn-Accountstring nullable

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

Example:cl_9f2c1ab84d7e4f1fa3c65b0e7d9a2c41
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

Request body

amountstring nullable

Exact amount funded in the source currency.

amountTostring nullable

Exact amount to settle to the account.

currencystring required

ISO 4217 fiat code or supported digital-asset symbol for amount.

rail'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'
originChainId'eth' | 'bsc' | 'avax' | 'op' | 'arb' | 'pol' | 'sol' | 'base' | 'gnosis' | 'tron' | 'xrp' | 'zec' | 'doge' | 'ltc' | 'btc' | 'cardano' | 'bera' | 'sui' | 'near' | 'near_intents' | 'xlayer' | 'plasma' | 'ton' | 'stellar' | 'monad' | 'starknet' | 'aptos' | 'adi' | 'bch'

Supported blockchain network code.

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

Response

Successful Response

idstring required

Stable public identifier for this incoming transfer.

status'pending' | 'awaitingFunds' | 'processing' | 'inReview' | 'completed' | 'failed' | 'refunded' | 'canceled' required
rail'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'
paymentReferencestring nullable

Reference that must accompany the account transfer.

originChainIdstring nullable

Network from which an on-chain transfer is funded.

destinationChainIdstring nullable

Network on which the transfer settles.

expiresAtstring date-time nullable

UTC timestamp after which the quote is no longer valid.

createdAtstring date-time required

UTC timestamp when the incoming transfer was created.

Example response

{
  "id": "pi_9f2c1ab84d7e4f1fa3c65b0e7d9a2c41",
  "quote": {
    "amount": "500.00",
    "settlementAmount": "500.00",
    "feeAmount": "500.00",
    "rate": "500.00"
  }
}

Changes

  • 299a3aa6f521Revision changes
    • 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 new FDIC_EUR enum value to the request property

    • 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

  • 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 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 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

      added the new KYC_CARDS enum value to the request property

    • info

      added the new RD enum value to the request property

    • info

      added the new USDC_ARB enum value to the request property

    • 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