API References

List client settlement transfers

get
https://app.bitgo-test.com/api/network/v1/enterprises//clients/settlementTransfers

Lists all settlement transfers for your OES client account.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
length ≥ 1
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.

currencies
array of strings

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

currencies
initiatedBy
array of strings

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

initiatedBy
partnerIds
array of strings

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

partnerIds
settlementIds
array of strings

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

settlementIds
settlementStatuses
array of strings

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

settlementStatuses
settlementTransferStatuses
array of strings

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

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

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.

string
enum
Allowed:
string
enum
Allowed:
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