GET

List client settlement transfers

Lists all settlement transfers for your OES client account.

Requires access token scope: settlement_network_read

Path Params

enterpriseId string required

at least 1 characters

Query Params

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.
currencies array of strings

Optional array of currencies. If provided will only return settlement transfers with those currencies.
initiatedBy array of strings

Optional array of user ids. If provided will only return settlement transfers for settlements initiated by those users.
partnerIds array of strings

Optional array of partner ids. If provided will only return settlement transfers for settlements initiated by those partners.
settlementIds array of strings

Optional array of settlement ids. If provided will only return settlement transfers for settlements with those ids.
settlementStatuses array of string enums

Optional array of settlement statuses. If provided will only return settlement transfers for settlements in those statuses.

failedcompletedpendingrejected
settlementTransferStatuses array of string enums

Optional array of settlement transfer statuses. If provided will only return settlement transfers with those statuses.

pendingpending_onchainonchain_initiatedonchain_failedcompletedfailedrejecteddisputedpending_settlement_assignment
settlementUpdatedBefore string date-time

optional date start range filter for updatedAt (ISO 8601 Date). If provided will only return settlement transfers for settlements updated before the provided date.
settlementUpdatedOnOrAfter string date-time

optional date start range filter for updatedAt (ISO 8601 Date). If provided will only return settlement transfers for settlements updated on or after the provided date.
sortField string enum

updatedAt
sortDirection string enum

ASCDESC

Responses

200

Response Body

object

settlementTransfers array of objects required
settlementTransfers object
- sourceTradingAccountId string
  
  The go account id of the source party.
  
  at least 1 characters
- sourceNetworkAccountId string
  
  The network account id of the source party.
- destinationTradingAccountId string
  
  The go account id of the destination party.
  
  at least 1 characters
- destinationNetworkAccountId string
  
  The network account id of the destination party (if the destination party is a connection).
- 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.
- 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
- usdValue string or number nullable required
  
  The USD value of the settlement transfer in cents. This is a non-negative value represented as a string.
- 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.
- 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.
- settlementStatus string enum required
  The status of the settlement the settlement transfer is associated with. Possible values and implications are:
  - pending: The settlement is pending and has not yet been processed.
  - failed: The settlement has failed to process. This is a non-terminal state and should be retried.
  - completed: The settlement has been completed successfully.
  - rejected: The settlement has been rejected by a BitGo admin (only relevant to on-chain settlements).
  failedcompletedpendingrejected
- settlementNotes string
  
  Optional notes for the settlement
  
  at least 1 characters
- sourceClientName string
  
  The client name of the source party. Will be obfuscated if the source party is not the calling client.
  
  at least 1 characters
- destinationClientName string
  
  The client name of the destination party. Will be obfuscated if the destination party is not the calling client.
  
  at least 1 characters
- sourceConnectionName string
  
  The name of the source connection (if the source party is a connection). Will be obfuscated if the source party is not the calling client.
  
  at least 1 characters
- destinationConnectionName string
  
  The name of the destination connection (if the destination party is a connection). Will be obfuscated if the destination party is not the calling client.
  
  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

curl --request GET \ --url 'https://app.bitgo-test.com/api/network/v1/enterprises/enterpriseId/clients/settlementTransfers&pageNumber=string&pageSize=string&currencies=&initiatedBy=&partnerIds=&settlementIds=&settlementStatuses=&settlementTransferStatuses=&settlementUpdatedBefore=string&settlementUpdatedOnOrAfter=string&sortField=updatedAt&sortDirection=ASC' \ --header 'accept: application/json' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

const url = 'https://app.bitgo-test.com/api/network/v1/enterprises/enterpriseId/clients/settlementTransfers&pageNumber=string&pageSize=string&currencies=&initiatedBy=&partnerIds=&settlementIds=&settlementStatuses=&settlementTransferStatuses=&settlementUpdatedBefore=string&settlementUpdatedOnOrAfter=string&sortField=updatedAt&sortDirection=ASC'; 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));

require 'uri' require 'net/http' url = URI("https://app.bitgo-test.com/api/network/v1/enterprises/enterpriseId/clients/settlementTransfers&pageNumber=string&pageSize=string&currencies=&initiatedBy=&partnerIds=&settlementIds=&settlementStatuses=&settlementTransferStatuses=&settlementUpdatedBefore=string&settlementUpdatedOnOrAfter=string&sortField=updatedAt&sortDirection=ASC") 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

<?php require_once('vendor/autoload.php'); $client = new \GuzzleHttp\Client(); $response = $client->request('GET', 'https://app.bitgo-test.com/api/network/v1/enterprises/enterpriseId/clients/settlementTransfers&pageNumber=string&pageSize=string&currencies=&initiatedBy=&partnerIds=&settlementIds=&settlementStatuses=&settlementTransferStatuses=&settlementUpdatedBefore=string&settlementUpdatedOnOrAfter=string&sortField=updatedAt&sortDirection=ASC', [ 'headers' => [ 'accept' => 'application/json', 'Authorization' => 'Bearer YOUR_ACCESS_TOKEN', ], ]); echo $response->getBody();

import requests url = "https://app.bitgo-test.com/api/network/v1/enterprises/enterpriseId/clients/settlementTransfers&pageNumber=string&pageSize=string&currencies=&initiatedBy=&partnerIds=&settlementIds=&settlementStatuses=&settlementTransferStatuses=&settlementUpdatedBefore=string&settlementUpdatedOnOrAfter=string&sortField=updatedAt&sortDirection=ASC" headers = { "accept": "application/json", "Authorization": "Bearer YOUR_ACCESS_TOKEN" } response = requests.get(url, headers=headers) print(response.text)

{ "settlementTransfers": [ { "sourceTradingAccountId": "string", "sourceNetworkAccountId": "string", "destinationTradingAccountId": "string", "destinationNetworkAccountId": "string", "currency": "string", "quantity": "string", "txIds": [ "string" ], "status": "pending", "usdValue": "string", "settlementId": "string", "disputeClosureId": "string", "id": "string", "createdAt": "string", "updatedAt": "string", "settlementStatus": "failed", "settlementNotes": "string", "sourceClientName": "string", "destinationClientName": "string", "sourceConnectionName": "string", "destinationConnectionName": "string" } ] }