---
title: "[Sandbox] Update payout status"
method: PUT
path: "/sandbox/fx/payouts/{payoutId}"
---

# \[Sandbox\] Update payout status

`PUT /sandbox/fx/payouts/{payoutId}`

## Request

- Base URL: `https://api-sandbox.straitsx.com/v1`
- URL: `https://api-sandbox.straitsx.com/v1/sandbox/fx/payouts/{payoutId}`
- Auth: API key in header `X-XFERS-APP-API-KEY`

[Available in Sandbox environment only] Manually transition a payout's status in the sandbox environment. Not available in production.

## Path parameters

- `payoutId` string, required

## Headers

- `X-XFERS-APP-API-KEY` string, required
- `X-PUBLIC-KEY-ID` string
- `X-TIMESTAMP` string
- `X-NONCE` string
- `X-SIGNATURE` string

## Request body

- object
  - `data` object
    - `attributes` object
      - `status` string, required: Target status. One of: `completed`, `cancelled`.

## Response `200`

200

- object
  - `data` object
    - `id` string: Payout ID, prefixed with `contract_`.
    - `type` string: Resource type. Always `fxPayout`.
    - `attributes` object
      - `status` string: Transaction status. One of: `pending`, `completed`, `failed`.
      - `quoteId` string: UUID of the quote used.
      - `recipientId` string: ID of the payout recipient used.
      - `rate` number: FX rate applied.
      - `from` object: Source currency and amount.
        - `currency` string
        - `amount` string
      - `to` object: Target currency and amount.
        - `currency` string
        - `amount` string
      - `fee` object: Fee charged. Contains `currency` and `amount`.
        - `currency` string
        - `amount` string
      - `createdAt` string: ISO 8601 timestamp of transaction creation (Singapore timezone).
      - `updatedAt` string: ISO 8601 timestamp of last status change (Singapore timezone).
      - `references` object: Reference identifiers for the payout.
        - `externalReference` string: External reference provided by the merchant.
        - `internalReference` string: Internal reference provided by the merchant.

## Other responses

- `400`: Bad Request
- `404`: Not Found

---

[API](https://skmtc.dev/straitsx/apis/straitsx-sandbox-base-url.md) - [All operations](https://skmtc.dev/straitsx/apis/straitsx-sandbox-base-url/llms.txt) - [OpenAPI document](https://skmtc.dev/straitsx/apis/straitsx-sandbox-base-url/revisions/d17239d67150?raw)