HEhevn-inc
transfers

Create an outgoing transfer quote

Changed on

Estimate rate, fees, limits and contact amount without creating a contact, transfer or external side effect.

post/payouts/preview

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

Request body

railstring required

Stable payment-method identifier to preview.

amountstring required

Source amount to price.

Example request

{
  "amount": "500.00"
}

Response

Successful Response

toAmountstring required

Estimated amount delivered in the destination currency.

toCurrencystring required

Currency delivered by the preview.

minAmountstring required

Minimum supported source amount for this option.

feeAmountstring nullable

Estimated variable fee.

fixedFeestring nullable

Estimated fixed fee component.

Example response

{
  "toAmount": "500.00",
  "minAmount": "500.00",
  "feeAmount": "500.00",
  "fixedFee": "500.00"
}

Changes

  • 299a3aa6f521Revision changes
    • warning

      added the new verification_not_applicable enum value to the / response property for the response 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