Search settlement

Security(Ledger_API_Key and Ledger_API_User) or Ledger_API_Key and Ledger_API_User and Ledger_Store_Auth_Token) or Ledger_API_User or Ledger_API_User and Ledger_Store_Auth_Token)

Request

query Parameters

page	integer or null >= 1 Default: 1 Defines the page number to be fetched. Example: page=3
page_size	integer or null >= -1 Default: 20 Defines the number of elements displayed on a page. Must be a positive number with 0 and -1 being special values to return a maximum defined in the gate Example: page_size=40

Responses

200

settlement search results

400

invalid search parameters

get/settlements

Response samples

application/json

{"edges": [{"cursor": 0,
"node": {"account_id": 0,
"amount": 0,
"asset_manager": {"approver_group_id": 0,
"code": "string",
"id": 0,
"name": "string",
"role": "string",
"whitelist_id": 0
},
"custodian": {"approver_group_id": 0,
"code": "string",
"id": 0,
"name": "string",
"role": "string",
"whitelist_id": 0
},
"exchange": {"approver_group_id": 0,
"code": "string",
"id": 0,
"name": "string",
"requires_pre_approval": true,
"role": "string",
"whitelist_id": 0
},
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"pending": 0,
"pledge_subaccount_id": 0,
"state": "ASSIGNED_TO_SETTLEMENT"
}
}
],
"page_info": {"count": 1,
"has_next_page": false
}
}