Sign in

v1

latestOpenAPI 3.1.02026-07-2411601020.7 KB

[Sandbox] Update payout status

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

put/sandbox/fx/payouts/{payoutId}

Path parameters

payoutIdstring required

UUID of the FX payout.

Headers

X-XFERS-APP-API-KEYstring required

You can retrieve this from your Dashboard Developer Tools.<br><br><strong>Note:</strong> The X-XFERS-APP-API-KEY is a mandatory header for all authentication methods, including standard API key usage and HTTP Request Signing mode.

X-PUBLIC-KEY-IDstring

The Key ID, can be retrieved from your StraitsX Dashboard.<br><br><strong>Note:</strong> This header attribute is required when HTTP Request Signing is enabled for your account.

X-TIMESTAMPstring

Current Unix epoch time in seconds. Must be within ±300 seconds of server time.<br><br><strong>Note:</strong> This header attribute is required when HTTP Request Signing is enabled for your account.

X-NONCEstring

A unique UUID string per request, used for replay protection. Must not be reused within the timestamp window.<br>Regex: /\A[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}\z/i<br><br><strong>Note:</strong> This header attribute is required when HTTP Request Signing is enabled for your account.

X-SIGNATUREstring

Base64-encoded digital signature of the canonical request string.<br><br><strong>Note:</strong> This header attribute is required when HTTP Request Signing is enabled for your account.

Request body

Response

200

Example response

{
  "data": {
    "id": "contract_d4d1da72-111e-4d52-bdbf-2e74a2d803d5",
    "type": "fxPayout",
    "attributes": {
      "status": "pending",
      "quoteId": "fx_quote_c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
      "recipientId": "payout_recipient_a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "rate": 15832.5,
      "from": {
        "currency": "XUSD",
        "amount": "1000.00"
      },
      "to": {
        "currency": "IDR",
        "amount": "15832500.00"
      },
      "fee": {
        "currency": "XUSD",
        "amount": "1.50"
      },
      "createdAt": "2025-03-25T20:04:05+08:00",
      "updatedAt": "2025-03-25T20:04:05+08:00",
      "references": {
        "externalReference": "INV-2025-001",
        "internalReference": "internal-ref-001"
      }
    }
  }
}