HEhevn-inc
transfers

Open the incoming transfer and retrieve funding instructions

Changed on

Idempotent: an already-open transfer returns the same payment-account details or on-chain deposit address. A quote that stopped holding answers 410 payin_expired.

post/payins/{payinId}/instructions

Request

Path parameters

payinIdstring required

Prefixed pay-in id

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

Response

Successful Response

payinIdstring required

Incoming-transfer identifier these instructions fund.

amountstring required

Exact amount to send.

currencystring required

Currency or digital asset to send.

paymentReferencestring nullable

Reference that must accompany the account transfer.

singleUseboolean required

Whether these instructions may fund only this incoming transfer once.

expiresAtstring date-time nullable

UTC timestamp after which these instructions expire.

qrPayloadstring nullable

Raw payload suitable for rendering as a payment QR code.

urlstring nullable

Hosted URL where the incoming transfer can be funded.

addressstring nullable

On-chain destination address.

memostring nullable

Memo or destination tag required by the on-chain transfer.

chainIdstring nullable

Network on which the destination address exists.

Example response

{
  "payinId": "pi_9f2c1ab84d7e4f1fa3c65b0e7d9a2c41",
  "amount": "500.00"
}

Changes

  • 299a3aa6f521Revision changes
    • breaking

      removed from the /// request property anyOf list

    • breaking

      removed from the /// request property anyOf list

    • breaking

      removed from the //// request property anyOf list

    • warning

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

    • info

      added to the /// request property anyOf list

    • info

      added to the /// request property anyOf list

    • info

      added to the //// request property anyOf list

    • 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

  • a02795de2d2bRevision changes
    • warning

      deleted the header request parameter x-api-key

    • 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