Skip to main content
GET

Authorizations

BIZ-API-KEY
string
header
required

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

limit
integer<int32>
default:10

The maximum number of objects to return. For most operations, the value range is [1, 50].

before
string

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.

after
string

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.

source_account
string
required

The source account for which to retrieve balance changes. Currently, use developer.

token_id
string

The token ID used to filter balance changes. For a complete list of supported tokens, see Cobo Payments Guide.

flow_direction
enum<string>

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.
Available options:
in,
out
Example:

"in"

min_created_timestamp
integer<int64>

The minimum creation time of balance changes, represented as a UNIX timestamp in seconds. Balance changes created on or after this time are returned.

max_created_timestamp
integer<int64>

The maximum creation time of balance changes, represented as a UNIX timestamp in seconds. Balance changes created on or before this time are returned.

source_type
enum<string>

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.
Available options:
Init,
OrderIn,
LatePayment,
TopUp,
UnexceptedIn,
RefundOut,
Payout,
UnexceptedOut,
Allocation,
SettlementNetwork,
BulkSend
Example:

"OrderIn"

source_id
string

The source ID used to filter balance changes.

When specifying source_id, you must also specify source_type.

Response

The request was successful. The response contains balance changes and pagination information.

The response containing balance changes and pagination information.

data
object[]

The list of balance changes.

pagination
object

The pagination information of the returned data.