Settlements

List settlements by Go Account

List all settlements for a given Go Account.

Use only with delivery versus payment (DVP) settlements.

Requires access token scope: wallet_view_all

get/api/clearing/v1/enterprise/{enterpriseId}/account/{accountId}/settlements

Request

  • Base URL
    https://developers.bitgo.com
  • URL
    https://developers.bitgo.com/api/clearing/v1/enterprise/{enterpriseId}/account/{accountId}/settlements
  • Auth
    none declared

Path parameters

enterpriseIdstring required
accountIdstring required

Query parameters

string required
OR
50 required
string required
OR
0 required
'canceled' | 'pending' | 'rejected' | 'settled' | 'expired' | 'pending-acknowledgement'
OR
string[]
counterpartyAccountIdsstring[]
dateInitiatedOnOrAfterstring date-time
dateInitiatedBeforestring date-time
omitRequesterAccountNameboolean
requiresSigningboolean
typesstring[]
batchIdstring[]
externalIdsstring[]
externalIdPrefixstring
includeTotalCountboolean

Response

OK

totalCountnumber

Changes

No operation changes recorded.