Put notes info into event for settlement

put/api/network/v1/admin/settlements/{settlementId}/onchain/notes

Admin route to provide event notes for a settlement

Path Parameters

  • settlementIdstringRequired

Query Parameters

  • trustOrgstringRequired
    Enum: BitGo Trust BitGo New York BitGo Germany BitGo Switzerland BitGo Europe ApS Frankfurt DE Trust BitGo Singapore BitGo Korea BitGo Custody MENA FZE BitGo India BitGo Sister Trust 1

Request Body

notes object required
notes string required
Min length: >= 1 characters

201 Response

settlementOne ofrequired
id string required
The unique identifier of the settlement. This is a UUID that uniquely identifies the settlement record.
partnerId string required
The unique identifier of the partner the settlement is associated with. This is a UUID that uniquely identifies the partner.
externalId string required
External identifier provided by the partner when creating the settlement.
Min length: >= 1 characters
status string required
Allowed value: pending
settlementType string required
The type of settlement. Possible values are: - onchain: The settlement is on-chain. - offchain: The settlement is off-chain.
Allowed values: onchain offchain
reconciled boolean required
Whether or not the settlement is reconciled against trade data. Currently there are no reconciled settlements. This field is always false.
initiatedBy string required
Id of the user which initiated the settlement.
Min length: >= 1 characters
notes string
The notes associated with the settlement. This is a free-form text field that can contain any additional information about the settlement.
Min length: >= 1 characters
createdAt string <date-time>required
The date and time when the settlement was created. This is a timestamp in ISO 8601 format.
updatedAt string <date-time>required
The date and time when the settlement was last updated. This is a timestamp in ISO 8601 format.
rtId string
Routed transaction id associated with the settlement. This is a UUID that uniquely identifies the routed transaction. This field is only populated for on-chain settlements for partners with automation enabled.
lossSLAAlertSent boolean required
Whether or not an alert has been sent if loss settlement SLA is close to being breached. Only relevant for on-chain settlements.
gainSLAAlertSent boolean required
Whether or not an alert has been sent if gain settlement SLA is close to being breached. Only relevant for on-chain settlements.
cutoffAt string <date-time>
The date and time of the newest trade being settled in the partner system. This is a timestamp in ISO 8601 format. This field is only populated for dispute enabled partners.
disputed boolean
Whether or not a dispute was raised on this settlement.
settlementActivity array[object] required
id string required
createdAtOne ofrequired
entityId string required
userId string required
Min length: >= 1 characters
notes string
Min length: >= 1 characters
entityType string required
Allowed value: settlement
event string required
Allowed values: INITIATED FAILED REJECTED COMPLETED CLIENT_LOSS_SETTLEMENT_COMPLETED CLIENT_LOSS_SETTLEMENT_FAILED GAIN_DEPOSITS_INITIATED CLIENT_GAIN_SETTLEMENT_FAILED COMMENT

400 Response

401 Response

error string required

404 Response

error string required

500 Response

error string required