---
title: "[Sandbox] Update status of mock regular payout"
method: PUT
path: "/sandbox/payouts/{contract_id}"
---

# \[Sandbox\] Update status of mock regular payout

`PUT /sandbox/payouts/{contract_id}`

## Request

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

[Available in Sandbox environment only] Update status of created regular payout from `pending` to either `completed` or `failed`

## Path parameters

- `contract_id` 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: Accepts only `completed` or `failed`

## Response `200`

200

- object
  - `data` object
    - `id` string: Payout contract ID.
    - `type` string: Request type.
    - `attributes` object
      - `amount` string: Transaction amount.
      - `createdAt` string: Timestamp when the transaction was created.
      - `description` string: Description of this transaction (contract) according to merchant.
      - `disbursementMethod` object: Disbursement details.
        - `accountNo` string: Bank account number.
        - `bankAbbrev` string: Bank abbreviation.
        - `currency` string: Transaction currency.
        - `type` string: Disbursement method type.
        - `walletName` string: Wallet from which funds are deducted.
      - `externalReference` string: External transaction reference which will be seen by the recipient.
      - `failureReason` string: Reason for failure (if applicable).
      - `fees` string: Fees charged for the transaction.
      - `idempotencyId` string: Idempotency ID for the transaction.
      - `status` string: Transaction status.
      - `updatedAt` string: Timestamp when the transaction was last updated.

---

[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)