List balance changes
This operation retrieves balance changes for the specified source account. Each balance change includes the source information, token ID, changed amount, account balances before and after the change, flow direction, and creation time.
You need to specify source_account. Currently, use developer as the source account. You can use pagination parameters to control the response size, and filter balance changes by token_id, flow_direction, min_created_timestamp, max_created_timestamp, source_type, or source_id.
source_id, you must also specify source_type.For more information, see Cobo Payments Guide.
Authorizations
The API key. For more details, refer to API key.
In the API playground, enter your API secret, and your API key will be accordingly calculated.
Query Parameters
The maximum number of objects to return. For most operations, the value range is [1, 50].
A cursor indicating the position before the current page. This value is generated by Cobo and returned in the response. If you are paginating forward from the beginning, you do not need to provide it on the first request. When paginating backward (to the previous page), you should pass the before value returned from the last response.
A cursor indicating the position after the current page. This value is generated by Cobo and returned in the response. You do not need to provide it on the first request. When paginating forward (to the next page), you should pass the after value returned from the last response.
The source account for which to retrieve balance changes. Currently, use developer.
The token ID used to filter balance changes. For a complete list of supported tokens, see Cobo Payments Guide.
The direction of the balance change relative to the source account. Possible values include:
in: Funds flow into the source account.out: Funds flow out of the source account.
in, out "in"
The minimum creation time of balance changes, represented as a UNIX timestamp in seconds. Balance changes created on or after this time are returned.
The maximum creation time of balance changes, represented as a UNIX timestamp in seconds. Balance changes created on or before this time are returned.
The source type used to filter balance changes. Possible values include:
Init: Balance change caused by initialization.OrderIn: Balance change from an order-in payment.LatePayment: Balance change from a late payment.TopUp: Balance change from a top-up.UnexceptedIn: Balance change from an unexpected incoming payment.RefundOut: Balance change from a refund payout.Payout: Balance change from a payout.UnexceptedOut: Balance change from an unexpected outgoing payment.Allocation: Balance change from an allocation.SettlementNetwork: Balance change from the settlement network.BulkSend: Balance change from a bulk send.
When specifying source_id, you must also specify source_type.
The source type of the balance change. Possible values include:
Init: Balance change caused by initialization.OrderIn: Balance change from an order-in payment.LatePayment: Balance change from a late payment.TopUp: Balance change from a top-up.UnexceptedIn: Balance change from an unexpected incoming payment.RefundOut: Balance change from a refund payout.Payout: Balance change from a payout.UnexceptedOut: Balance change from an unexpected outgoing payment.Allocation: Balance change from an allocation.SettlementNetwork: Balance change from the settlement network.BulkSend: Balance change from a bulk send.
Init, OrderIn, LatePayment, TopUp, UnexceptedIn, RefundOut, Payout, UnexceptedOut, Allocation, SettlementNetwork, BulkSend "OrderIn"
The source ID used to filter balance changes.
When specifying source_id, you must also specify source_type.
