HEhevn-inc
escrow

Submit the signature for a prepared escrow action

Changed on

Submit the signature for the previously prepared escrow action. The path idempotency key must match the prepared action and makes safe retries return the first result.

post/escrow/{escrowId}/actions/{idempotencyKey}/confirm

Request

Path parameters

escrowIdstring required
idempotencyKeystring 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

Request body

signaturestring required

Base64 DER ECDSA P-256/SHA-256 signature over the decoded approval payload.

publicKeystring nullable

Registered P-256 public key; omit when the signature uniquely identifies the key.

Response

Successful Response

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

      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