Skip to main content
GET
Get transaction breakdown

Authorizations

Authorization
string
header
required

Bearer Authentication

Headers

X-BU-PROFILE-ID
string

User profile header

Example:

"BUS_YOK8tp5Zga01qOKEsqp07"

Query Parameters

currency
string

Restrict the breakdown to a single currency. Counts all currencies when omitted.

Example:

"NGN"

start_date
string<date>

Start of the reporting range (inclusive, UTC). Defaults to 30 days before end_date.

end_date
string<date>

End of the reporting range (inclusive, UTC). Defaults to today.

group_by
enum<string>

Dimension to group transactions by. Defaults to status. Dimension to group the transaction breakdown by. payment_method buckets transactions into payment rails (bank_transfer, mobile_money, direct_debit, crypto, others) derived from their category.

Available options:
status,
payment_method
Example:

"status"

Response

Successful response

General response Values

status
enum<string>
required
Available options:
success,
error
Example:

"success"

message
string
required
Example:

"message for success"

data
object
required

Transaction counts grouped by a dimension.