Sign in
Balances API

List balance transactions

Retrieve a list of all balance transactions. Transactions include for example payments, refunds, chargebacks, and settlements.

For an aggregated report of these balance transactions, refer to the Get balance report endpoint.

The alias primary can be used instead of the balance ID to refer to the organization's primary balance.

The results are paginated.

get/v2/balances/{balanceId}/transactions

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.

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 balance transaction objects.

Changes

Changed in 6 of the 92 revisions of this API.1103

  • 8fa74580d99f2See the full diff
    • ●

      added the new api-payment-rolling-reserve-release enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new post-payment-split-payment enum value to the /// response property for the response status

      response-property-enum-value-added

  • 0cbba39eed3c2See the full diff
    • ●

      added the new application-fee enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new payment-fee enum value to the /// response property for the response status

      response-property-enum-value-added

  • 475da734189331See the full diff
    • ●

      added the new balance-charge-fee enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new cash-collateral-issuance enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new outgoing-custom-amount-transfer enum value to the /// response property for the response status

      response-property-enum-value-added

    • ○

      removed the cash-collateral-issuance'; enum value from the /// response property for the response status

      response-property-enum-value-removed

  • 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

  • 20aca7db688d3See the full diff
    • ●

      added the new invoice-compensation enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new movement enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new topup enum value to the /// response property for the response status

      response-property-enum-value-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.