HEhevn-inc
escrow

Prepare an escrow action and return the payload to sign

Changed on

Prepare an escrow action and return the immutable payload to sign. This request does not broadcast the action.

post/escrow/{escrowId}/actions

Request

Path parameters

escrowIdstring required

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

action'authorize' | 'charge' | 'capture' | 'void' | 'refund' required
amountstring nullable

Token amount affected by this action, when required.

feeBpsinteger

Variable fee in basis points for charge or capture actions.

Response

OK

pollUrlstring nullable

Relative API URL to poll while processing continues.

Example response

{
  "deal": {
    "maxAmount": "500.00",
    "authorizedAmount": "500.00",
    "capturableAmount": "500.00",
    "refundableAmount": "500.00",
    "action": {
      "amount": "500.00"
    }
  },
  "action": {
    "amount": "500.00"
  },
  "events": [
    {
      "amount": "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
    • breaking

      removed the enum value reclaim of the request property

    • 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

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the 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

    • info

      added the required property / to the response with the status