---
title: "Move an emulated outgoing transfer to its next reported status"
method: POST
path: "/sandbox/payouts/{payoutId}/status"
tags: ["sandbox"]
---

# Move an emulated outgoing transfer to its next reported status

`POST /sandbox/payouts/{payoutId}/status`

## Request

- The document declares no server URL.
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/hevn-inc/apis/hevn-api/docs/sandbox/payouts/:payoutId/status/post.ts> (a function with typed inputs; its response is checked against the schema)

## Path parameters

- `payoutId` string, required

## Headers

- `X-Hevn-Account` string, nullable: The client account to act for, as a `cl_…` id. Omit it to act as yourself.
- `Idempotency-Key` string, 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.

## Request body

- SandboxPayoutStatusRequest
  - `status` 'awaitingSignature' | 'submitted' | 'settled' | 'failed' | 'refunded', required

## Response `200`

Successful Response

- SandboxPayoutResponse
  - `payoutId` string, required: Outgoing-transfer identifier updated by the emulator.
  - `status` 'awaitingSignature' | 'submitted' | 'settled' | 'failed' | 'refunded', required
  - `amount` string, required: Transfer amount.
  - `currency` string, required: Transfer currency or digital asset.
  - `idempotencyKey` string, required: Caller-supplied key that binds retries to this update.
  - `transactionId` string, nullable: Ledger transaction identifier, when created.
  - `txHash` string, nullable: Settlement transaction hash, when applicable.
  - `refundTxHash` string, nullable: Refund transaction hash, when applicable.

## Other responses

- `202`: Accepted
- `422`: Request validation failed

## Changes

- **2026-11-12** `299a3aa6f521`: 1 warning, 2 info
  - added the new `verification_not_applicable` enum value to the `error/code` response property for the response status `422`
  - removed the `phone_required` enum value from the `error/code` response property for the response status `422`
  - removed the `rail_requirements_unmet` enum value from the `error/code` response property for the response status `422`
- **2026-10-23** `a02795de2d2b`: 9 warning, 5 info
  - deleted the `header` request parameter `x-api-key`
  - added the new `client_already_linked` enum value to the `error/code` response property for the response status `422`
  - added the new `kyb_documents_processing` enum value to the `error/code` response property for the response status `422`
  - added the new `link_code_expired` enum value to the `error/code` response property for the response status `422`
  - …10 more
- **2026-10-20** `19eb00e9f258`: 1 info
  - removed the `phone_in_use` enum value from the `error/code` response property for the response status `422`
- **2026-10-20** `bd6c9d69540e`: 1 warning
  - added the new `phone_in_use` enum value to the `error/code` response property for the response status `422`
- **2026-10-20** `19eb00e9f258`: 1 info
  - removed the `document_fields_missing` enum value from the `error/code` response property for the response status `422`

[Operation history](https://skmtc.dev/hevn-inc/apis/hevn-api/changes/sandbox/payouts/:payoutId/status/post.md)

---

[API](https://skmtc.dev/hevn-inc/apis/hevn-api.md) - [All operations](https://skmtc.dev/hevn-inc/apis/hevn-api/llms.txt) - [OpenAPI document](https://skmtc.dev/hevn-inc/apis/hevn-api/revisions/299a3aa6f521?raw)