Sign in
Balance Transfers API

List all Connect balance transfers

Returns a paginated list of balance transfers associated with your organization. These may be a balance transfer that was received or sent from your balance, or a balance transfer that you initiated on behalf of your clients. If no balance transfers are available, the resulting array will be empty. This request should never throw an error.

get/v2/connect/balance-transfers

Query parameters

fromstring nullable

Provide an ID to start the result set from the item with the given ID and onwards. This allows you to paginate the result set.

limitinteger nullable
Example:50

The maximum number of items to return. Defaults to 50 items.

sort'asc' | 'desc'
Example:desc

Used for setting the direction of the result set. Defaults to descending order, meaning the results are ordered from newest to oldest.

testmodeboolean

You can enable test mode by setting the testmode query parameter to true.

Test entities cannot be retrieved when the endpoint is set to live mode, and vice versa.

Headers

idempotency-keystring
Example:123e4567-e89b-12d3-a456-426

A unique key to ensure idempotent requests. This key should be a UUID v4 string.

Response

A list of Connect balance transfers. For a complete reference of the Connect balance transfer object, refer to the Get balance transfer endpoint documentation.

Changes

Changed in 3 of the 92 revisions of this API.13

  • 1bcb76dbe9ea1See the full diff
    • ▲

      the response property's min was decreased from 1.00 to 0.00 for the response status

      response-property-min-decreased

  • 7cab62b218301See the full diff
    • ○

      added the non-success response with the status

      response-non-success-status-added

  • ef4b5a97b56a2See the full diff
    • ○

      the endpoint scheme security advancedAccessToken was added to the API

      api-security-added

    • ○

      the endpoint scheme security organizationAccessToken was removed from the API

      api-security-removed

    This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Of the 92 revisions, 9 have no diff computed.