API References

List Partner Settlements

get
https://app.bitgo-test.com/api/network/v1/enterprises//partners/settlements

Lists all settlements for your OES partner account with filtering options. Results can be filtered by various parameters and are paginated.

Error scenarios:

  • 400: Invalid Request Error

  • Occurs when the request parameters are invalid or malformed.

  • Examples: Invalid UUID format, invalid pagination parameters.

  • 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.

  • 500: Internal Server Error

  • Occurs when there's an unexpected server error processing the request.

  • Examples: Database connection issues, query errors.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
length ≥ 1

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

Query Params
string

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.

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.

settlementIds
array of strings

Filter by specific settlement IDs. When provided, only settlements matching these IDs will be returned.

settlementIds
boolean

Filter to show only disputed settlements. When set to true, only settlements that have disputes will be returned. Setting to false will have no effect.

partnerIds
array of strings

Filter by specific partner IDs. When provided, only settlements involving these partners will be returned.

partnerIds
partyConnectionIds
array of strings

Filter by specific party connection IDs. When provided, only settlements involving these connections as parties will be returned.

partyConnectionIds
counterpartyConnectionIds
array of strings

Filter by specific counterparty connection IDs. When provided, only settlements involving these connections as counterparties will be returned.

counterpartyConnectionIds
externalIds
array of strings

Filter by specific external IDs. When provided, only settlements with these external IDs will be returned.

externalIds
date-time

Filter for settlements created on or after this date. Format: ISO 8601 date string.

date-time

Filter for settlements created before this date. Format: ISO 8601 date string.

date-time

Filter for settlements updated on or after this date. Format: ISO 8601 date string.

date-time

Filter for settlements updated before this date. Format: ISO 8601 date string.

Responses

Updated about 1 month ago

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 month ago