Ctrl+K

Update Settlement

put/trade-falcon/api/v2/admin/settlements/{settlementId}

Path Parameters

  • settlementIdstring<uuid>Required
    The UUID of the settlement to update

Request Body

status string
Current status of the settlement
Allowed values: STAGING STAGED SETTLING SETTLED FAILED CANCELED CANCELING SETTLING_FAILED TRANSFERRED
Example: STAGED
memo string
Optional memo
Max length: <= 500 characters
Example: Updated settlement memo
trustOrg string required
Trust organization identifier
Min length: >= 1 characters
Example: BitGo Trust

202 Response

settlementId string <uuid>required
Unique identifier for the settlement
Example: 550e8400-e29b-41d4-a716-446655440000
status string required
Current status of the settlement
Allowed values: STAGING STAGED SETTLING SETTLED FAILED CANCELED CANCELING SETTLING_FAILED TRANSFERRED
Example: STAGED
updateTime string <date-time>required
Timestamp when the settlement was last updated (ISO 8601 format)
Example: 2024-12-01T10:00:00.000Z

400 Response

error string required
Human-readable error message
errorName string required
Immutable error code for API integration
reqId string required
Client request id