GET

Get Partner Settlement

Returns a settlement for your OES partner account by its ID. This endpoint provides detailed information about a specific settlement, including its status, amounts, and related transfers.

Error scenarios:

400: Invalid Request Error
Occurs when the request parameters are invalid or malformed.
Examples: Invalid UUID format for settlementId, invalid enterpriseId format.
401: Authentication Error
Occurs when the request is not authorized.
Examples: Caller is not a member of the enterprise.
403: Permission Denied Error
Occurs when the authenticated partner doesn't have necessary permissions.
Examples: Enterprise does not have OES license.
404: Not Found Error
Occurs when the specified settlement cannot be found.
Examples: Settlement ID doesn't exist or doesn't belong to this partner.
500: Internal Server Error
Occurs when there's an unexpected server error processing the request.
Examples: Database connection issues.

Requires access token scope: settlement_network_read

Path Params

enterpriseId string required

The enterprise identifier of the partner. This identifies the partner enterprise making the API request.

at least 1 characters
settlementId string required

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

Query Params

sourceNetworkAccountIds array of strings

Filter by specific source network account IDs. When provided, only settlement transfers from these network accounts will be included.
sourceTradingAccountIds array of strings

Filter by specific source trading account IDs. When provided, only settlement transfers from these trading accounts will be included.
destinationNetworkAccountIds array of strings

Filter by specific destination network account IDs. When provided, only settlement transfers to these network accounts will be included.
destinationTradingAccountIds array of strings

Filter by specific destination trading account IDs. When provided, only settlement transfers to these trading accounts will be included.
currencies array of strings

Filter by specific currencies. When provided, only settlement transfers involving these currencies will be included.
pageNumber string integer

The page number (integer) you wish to fetch. When provided, the API will skip pageSize * pageNumber records. Page numbers are zero-based, so the first page is 0. If not provided, defaults to 0.
pageSize string

The page size (integer) you wish to fetch. When provided, the API will return at most pageSize records per page. If not provided, a default page size defined by the server will be used.

Responses

200

Response Body

object

settlement object required

The complete settlement object.
ONE OF
- 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.
  
  at least 1 characters
- status string enum required
  
  pending
- settlementType string enum required
  The type of settlement. Possible values are:
  
  onchain: The settlement is on-chain.
  
  offchain: The settlement is off-chain.
  onchainoffchain
- 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.
  
  at least 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.
  
  at least 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.
- 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.
  
  at least 1 characters
- reason string required
  
  at least 1 characters
- status string enum required
  
  failed
- settlementType string enum required
  The type of settlement. Possible values are:
  
  onchain: The settlement is on-chain.
  
  offchain: The settlement is off-chain.
  onchainoffchain
- 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.
  
  at least 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.
  
  at least 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.
- 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.
  
  at least 1 characters
- status string enum required
  
  completed
- settlementType string enum required
  The type of settlement. Possible values are:
  
  onchain: The settlement is on-chain.
  
  offchain: The settlement is off-chain.
  onchainoffchain
- 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.
  
  at least 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.
  
  at least 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.
- finalizedAt string date-time required
- 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.
- 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.
  
  at least 1 characters
- reason string required
  
  at least 1 characters
- status string enum required
  
  rejected
- settlementType string enum required
  The type of settlement. Possible values are:
  
  onchain: The settlement is on-chain.
  
  offchain: The settlement is off-chain.
  onchainoffchain
- 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.
  
  at least 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.
  
  at least 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.
- finalizedAt string date-time required
- 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.
settlementTransfers array of objects required
settlementTransfers object
- 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.
  
  at least 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 of strings required
- status string enum 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.
  pendingpending_onchainonchain_initiatedonchain_failedcompletedfailedrejecteddisputedpending_settlement_assignment
- sourceTradingAccountId string required
  
  The go account id of the source party.
  
  at least 1 characters
- sourceNetworkAccountId string
  
  The network account id of the source party.
- destinationTradingAccountId string required
  
  The go account id of the destination party.
  
  at least 1 characters
- destinationNetworkAccountId string required
  
  The network account id of the destination party.
settlingDisputes array of objects required

The disputes that are being settled as part of this settlement.
settlingDisputes object
- settledInSettlementId string required
- disputeClosureId string required
- disputeClosure object required
  disputeClosure object
  - id string required
    
    The unique identifier of the dispute closure.
  - closedBy string enum required
    
    Who closed the dispute.
    
    admin - The dispute was closed by an admin.
    
    client - The dispute was closed by a client.
    
    clientadmin
  - userId string required
    
    The id of the user who closed the dispute.
    
    at least 1 characters
  - notes string required
    
    notes entered by the user when closing the dispute.
    
    at least 1 characters
  - adjustedSettlementTransfers array of objects required
    
    The resulting settlement transfers generated when the dispute was closed
    
    adjustedSettlementTransfers object
    
    id string required
    
    The unique identifier of the settlement transfer.
    
    sourceTradingAccountId string required
    
    The go account id of the source party.
    
    at least 1 characters
    
    destinationTradingAccountId string required
    
    The go account id of the destination party.
    
    at least 1 characters
    
    destinationNetworkAccountId string required
    
    The network account id of the destination party.
    
    disputeClosureId string required
    
    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.
    
    currency string required
    
    The currency involved in the settlement movement.
    
    at least 1 characters
    
    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.
    
    status string enum 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.
    
    pendingpending_onchainonchain_initiatedonchain_failedcompletedfailedrejecteddisputedpending_settlement_assignment
    
    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.
    
    settlementId string
    
    The unique identifier of the settlement the settlement transfer is associated with. This is a UUID that uniquely identifies the settlement. Will only be undefined if the settlement transfer is in pending_settlement_assignment status.
    
    sourceNetworkAccountId string
    
    The network account id of the source party.
  - createdAt string date-time required
    
    The date and time when the dispute closure was created.
  - status string enum required
    
    The status of the dispute closure review.
    
    pending_reviewapprovedrejected
  - adjustedTransfers map of strings required
    
    The adjusted transfers as a result of the dispute closure.
    
    adjustedTransfers object
    
    <key> string
  - reviewedBy string
    
    The id of the admin who reviewed the dispute closure.
    
    at least 1 characters
  - reviewNotes string
    
    Any comments entered by the admin when reviewing the dispute closure.
    
    at least 1 characters
- id string required
- createdAt string date-time required
- updatedAt string date-time required
- connectionId string required
- disputedSettlementId string required
- userId string required
  
  at least 1 characters
- expectedTransfers map of strings required
  expectedTransfers object
  - <key> string
- retracted boolean required
- settledInSettlementId string required
- reason string
  
  at least 1 characters
- retractedBy string
  
  at least 1 characters
- retractedAt string date-time
- disputeClosureId string required
- retractedReason string
  
  at least 1 characters
settlementDisputes array of objects required

The disputes that were raised on this settlement.
settlementDisputes object
- disputeClosure object
  disputeClosure object
  - Same shape as DisputeClosureOutput.
- id string required
- createdAt string date-time required
- updatedAt string date-time required
- connectionId string required
- disputedSettlementId string required
- userId string required
  
  at least 1 characters
- expectedTransfers map of strings required
  expectedTransfers object
  - Same shape as ExpectedTransfersOutput.
- retracted boolean required
- settledInSettlementId string
- reason string
  
  at least 1 characters
- retractedBy string
  
  at least 1 characters
- retractedAt string date-time
- disputeClosureId string
- retractedReason string
  
  at least 1 characters

400

Bad Request

No response body

401

Unauthorized

Response Body

object

error string required

403

Forbidden

Response Body

object

error string required

404

Not Found

Response Body

object

error string required

500

Internal Server Error

Response Body

object

error string required

Language

Credentials

Bearer

Request

curl --request GET \
     --url 'https://app.bitgo-test.com/api/network/v1/enterprises/enterpriseId/partners/settlements/settlementId&sourceNetworkAccountIds=&sourceTradingAccountIds=&destinationNetworkAccountIds=&destinationTradingAccountIds=&currencies=&pageNumber=string&pageSize=string' \
     --header 'accept: application/json' \
     --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Request

const url = 'https://app.bitgo-test.com/api/network/v1/enterprises/enterpriseId/partners/settlements/settlementId&sourceNetworkAccountIds=&sourceTradingAccountIds=&destinationNetworkAccountIds=&destinationTradingAccountIds=&currencies=&pageNumber=string&pageSize=string';
const options = {method: 'GET', headers: {accept: 'application/json', 'Authorization': 'Bearer YOUR_ACCESS_TOKEN'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

Request

require 'uri'
require 'net/http'

url = URI("https://app.bitgo-test.com/api/network/v1/enterprises/enterpriseId/partners/settlements/settlementId&sourceNetworkAccountIds=&sourceTradingAccountIds=&destinationNetworkAccountIds=&destinationTradingAccountIds=&currencies=&pageNumber=string&pageSize=string")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["accept"] = 'application/json'
request["Authorization"] = 'Bearer YOUR_ACCESS_TOKEN'

response = http.request(request)
puts response.read_body

Request

<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://app.bitgo-test.com/api/network/v1/enterprises/enterpriseId/partners/settlements/settlementId&sourceNetworkAccountIds=&sourceTradingAccountIds=&destinationNetworkAccountIds=&destinationTradingAccountIds=&currencies=&pageNumber=string&pageSize=string', [
  'headers' => [
    'accept' => 'application/json',
    'Authorization' => 'Bearer YOUR_ACCESS_TOKEN',
  ],
]);

echo $response->getBody();

Request

import requests

url = "https://app.bitgo-test.com/api/network/v1/enterprises/enterpriseId/partners/settlements/settlementId&sourceNetworkAccountIds=&sourceTradingAccountIds=&destinationNetworkAccountIds=&destinationTradingAccountIds=&currencies=&pageNumber=string&pageSize=string"

headers = {
    "accept": "application/json",
    "Authorization": "Bearer YOUR_ACCESS_TOKEN"
}

response = requests.get(url, headers=headers)

print(response.text)

Response

{
  "settlement": {
    "id": "string",
    "partnerId": "string",
    "externalId": "string",
    "status": "pending",
    "settlementType": "onchain",
    "reconciled": true,
    "initiatedBy": "string",
    "notes": "string",
    "createdAt": "string",
    "updatedAt": "string",
    "rtId": "string",
    "lossSLAAlertSent": true,
    "gainSLAAlertSent": true,
    "cutoffAt": "string",
    "disputed": true
  },
  "settlementTransfers": [
    {
      "id": "string",
      "createdAt": "string",
      "updatedAt": "string",
      "currency": "string",
      "settlementId": "string",
      "disputeClosureId": "string",
      "quantity": "string",
      "txIds": [
        "string"
      ],
      "status": "pending",
      "sourceTradingAccountId": "string",
      "sourceNetworkAccountId": "string",
      "destinationTradingAccountId": "string",
      "destinationNetworkAccountId": "string"
    }
  ],
  "settlingDisputes": [
    {
      "settledInSettlementId": "string",
      "disputeClosureId": "string",
      "disputeClosure": {
        "id": "string",
        "closedBy": "client",
        "userId": "string",
        "notes": "string",
        "adjustedSettlementTransfers": [
          {
            "id": "string",
            "sourceTradingAccountId": "string",
            "destinationTradingAccountId": "string",
            "destinationNetworkAccountId": "string",
            "disputeClosureId": "string",
            "currency": "string",
            "quantity": "string",
            "status": "pending",
            "createdAt": "string",
            "updatedAt": "string",
            "settlementId": "string",
            "sourceNetworkAccountId": "string"
          }
        ],
        "createdAt": "string",
        "status": "pending_review",
        "adjustedTransfers": {
          "key": "string"
        },
        "reviewedBy": "string",
        "reviewNotes": "string"
      },
      "id": "string",
      "createdAt": "string",
      "updatedAt": "string",
      "connectionId": "string",
      "disputedSettlementId": "string",
      "userId": "string",
      "expectedTransfers": {
        "key": "string"
      },
      "retracted": true,
      "settledInSettlementId": "string",
      "reason": "string",
      "retractedBy": "string",
      "retractedAt": "string",
      "disputeClosureId": "string",
      "retractedReason": "string"
    }
  ],
  "settlementDisputes": [
    {
      "disputeClosure": {
        "id": "string",
        "closedBy": "client",
        "userId": "string",
        "notes": "string",
        "adjustedSettlementTransfers": [
          {
            "id": "string",
            "sourceTradingAccountId": "string",
            "destinationTradingAccountId": "string",
            "destinationNetworkAccountId": "string",
            "disputeClosureId": "string",
            "currency": "string",
            "quantity": "string",
            "status": "pending",
            "createdAt": "string",
            "updatedAt": "string",
            "settlementId": "string",
            "sourceNetworkAccountId": "string"
          }
        ],
        "createdAt": "string",
        "status": "pending_review",
        "adjustedTransfers": {
          "key": "string"
        },
        "reviewedBy": "string",
        "reviewNotes": "string"
      },
      "id": "string",
      "createdAt": "string",
      "updatedAt": "string",
      "connectionId": "string",
      "disputedSettlementId": "string",
      "userId": "string",
      "expectedTransfers": {
        "key": "string"
      },
      "retracted": true,
      "settledInSettlementId": "string",
      "reason": "string",
      "retractedBy": "string",
      "retractedAt": "string",
      "disputeClosureId": "string",
      "retractedReason": "string"
    }
  ]
}

{}

{
  "error": "string"
}

{
  "error": "string"
}

{
  "error": "string"
}

{
  "error": "string"
}