Sign in
Reports

Trybe Payments balance report

A running ledger of Trybe Payments (Adyen balance platform) transfers — payments, refunds, and payouts — for the given site over the requested date range. Use this to reconcile the merchant's balance held with Trybe Payments. Defaults to the current calendar month if date_from / date_to are omitted.

get/shop/reports/trybe-payments-balance

Query parameters

site_idstring uuid required

The site whose Trybe Payments balance is being reported on.

date_fromstring date

Restrict results to those on or after this date, ISO-8601 YYYY-MM-DD.

date_tostring date

Restrict results to those on or before this date, ISO-8601 YYYY-MM-DD.

pageinteger

The page to retrieve results from

Response

The balance report was successfully generated.

idstring required

The Adyen transfer ID.

timestring date-time required
eventstring required

The Adyen event name that produced this balance movement.

typestring required
payment_idstring object-id nullable
refund_idstring object-id nullable
payable_idstring object-id nullable
payable_typestring nullable

The downcased class basename of the payable model (e.g. basket, membership).

order_refstring nullable
amountinteger required

The transfer amount, in minor units. Positive for credits, negative for debits.

balanceinteger required

The running balance after this transfer, in minor units.

Example response

[
  {
    "event": "AUTHORISATION",
    "type": "card_payment"
  }
]

Changes

No recorded changes to this endpoint across all 1 revision of this API.