HEhevn-inc
sandbox

Move an emulated outgoing transfer to its next reported status

Changed on
post/sandbox/payouts/{payoutId}/status

Request

Path parameters

payoutIdstring 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

status'awaitingSignature' | 'submitted' | 'settled' | 'failed' | 'refunded' required

Response

Successful Response

payoutIdstring required

Outgoing-transfer identifier updated by the emulator.

status'awaitingSignature' | 'submitted' | 'settled' | 'failed' | 'refunded' required
amountstring required

Transfer amount.

currencystring required

Transfer currency or digital asset.

idempotencyKeystring required

Caller-supplied key that binds retries to this update.

transactionIdstring nullable

Ledger transaction identifier, when created.

txHashstring nullable

Settlement transaction hash, when applicable.

refundTxHashstring nullable

Refund transaction hash, when applicable.

Example response

{
  "payoutId": "po_9f2c1ab84d7e4f1fa3c65b0e7d9a2c41",
  "amount": "500.00",
  "transactionId": "txn_9f2c1ab84d7e4f1fa3c65b0e7d9a2c41"
}

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