Ledger balances

Balance snapshots

Capture a balance snapshot with the Go SDK.

POST/balances-snapshots

Use client.LedgerBalance.CreateSnapshot to trigger balance snapshot processing on demand.

Call the method

result, _, _ := client.LedgerBalance.CreateSnapshot(
	blnkgo.CreateBalanceSnapshotRequest{
		BatchSize: 500,
	},
)
FieldTypeDescription
BatchSizeintOptional. Server default is 1000. Omit or set to 0 to use the default.

Response

{
  "message": "Snapshotting in progress. should be completed shortly"
}

Go response (*blnkgo.CreateBalanceSnapshotResponse)

FieldTypeDescription
MessagestringStatus message when the snapshot job starts.