Ctrl+K

Admin GET Settlement

get/api/network/v1/admin/settlements/{settlementId}

Path Parameters

  • settlementIdstringRequired
    The unique identifier of the settlement to retrieve. This is a UUID that uniquely identifies the settlement record.

Query Parameters

  • trustOrgstringRequired
    Trust organization identifier. Used for filtering by the trust organization the settlement belongs to.
    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

200 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
onChainWithdrawals dictionary<string, object> required
object
settlingDisputes array[object] required
settledInSettlementId string required
disputeClosureId string required
disputeClosure object required
id string required
createdAt string <date-time>required
updatedAt string <date-time>required
connectionId string required
disputedSettlementId string required
userId string required
Min length: >= 1 characters
expectedTransfers dictionary<string, string> required
retracted boolean required
reason string
Min length: >= 1 characters
retractedBy string
Min length: >= 1 characters
retractedAt string <date-time>
retractedReason string
Min length: >= 1 characters
settlementDisputes array[object] required
disputeClosure object
id string required
createdAt string <date-time>required
updatedAt string <date-time>required
connectionId string required
disputedSettlementId string required
userId string required
Min length: >= 1 characters
expectedTransfers dictionary<string, string> required
retracted boolean required
settledInSettlementId string
reason string
Min length: >= 1 characters
retractedBy string
Min length: >= 1 characters
retractedAt string <date-time>
disputeClosureId string
retractedReason string
Min length: >= 1 characters
settlementTransfers array[object] required
usdValue string required
The USD value of the settlement transfer in cents. This is a non-negative value represented as a string.
id string required
The unique identifier of the settlement transfer. This is a UUID that uniquely identifies the settlement transfer record.
createdAt string <date-time>required
The date and time when the settlement transfer was created. Represented as an ISO 8601 formatted date string.
updatedAt string <date-time>required
The date and time when the settlement transfer was last updated. Represented as an ISO 8601 formatted date string.
currency string required
The currency involved in the settlement movement.
Min length: >= 1 characters
settlementId string required
The unique identifier of the settlement the settlement transfer is associated with. This is a UUID that uniquely identifies the settlement.
disputeClosureId string
The unique identifier of the dispute closure the settlement transfer was created from. This is a UUID that uniquely identifies dispute closure if the transfer was created as a result of closing a dispute.
quantity string required
The amount of currency being transferred in the settlement transfer. This is a non-zero value represented as a string. If the value is positive, that means funds were moved from the source account to the destination account. If the value is negative, that means funds were moved from the destination account to the source account.
txIds array[string] required
The transaction IDs associated with the settlement transfer. Only populated once the transfer is completed.
status string required
The status of the settlement transfer. Possible values and implications are: - pending: The transfer is pending and has not yet been processed. - pending_onchain: The transfer is pending on-chain movement (only relevant to on-chain settlements). - onchain_initiated: The transfer has been initiated on-chain (only relevant to on-chain settlements). - onchain_failed: The on-chain transfer has failed (only relevant to on-chain settlements). - completed: The transfer has been completed successfully. - failed: The transfer has failed. - rejected: The transfer has been rejected. - disputed: The transfer is disputed.
Allowed values: pending pending_onchain onchain_initiated onchain_failed completed failed rejected disputed pending_settlement_assignment
sourceTradingAccountId string required
The go account id of the source party.
Min length: >= 1 characters
sourceNetworkAccountId string
The network account id of the source party.
destinationTradingAccountId string required
The go account id of the destination party.
Min length: >= 1 characters
destinationNetworkAccountId string required
The network account id of the destination party.
sendsInUsd string required
receivesInUsd string required
limitBreached boolean required
payloadForLossSettlement string <json>
payloadForGainSettlement string <json>
payloadForLossReversal string <json>
onChainWithdrawRequired boolean required
depositInfo dictionary<string, object> required
object
rejectable boolean required

400 Response

401 Response

error string required

403 Response

error string required

404 Response

error string required

500 Response

error string required