Skip to content

List transactions

GET
/v1/wallet/transactions

Returns the signed-in user's top-ups and processing charges, most recent first, along with lifetime totals and the current balance. Page through a long history with skip and take.

Authorizations

Bearer

JWT bearer token from POST /v1/auth/login.

Type
HTTP (bearer)
or
ApiKey

Scoped API key for non-interactive clients (issued by PBI #1426).

Type
API Key (header: X-Api-Key)

Parameters

Query Parameters

skip
Type
[ "integer", "string" ]
Format
"int32"
Pattern
"^-?(?:0|[1-9]\\d*)$"
take
Type
[ "integer", "string" ]
Format
"int32"
Pattern
"^-?(?:0|[1-9]\\d*)$"

Responses

OK

application/json

A page of the owner's transaction history with lifetime totals and the count for pagination (#1363).

The owner's current balance, USD.

Format"double"
Pattern"^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$"

The transactions on this page, most recent first.

The offset this page started at.

Format"int32"
Pattern"^-?(?:0|[1-9]\\d*)$"

Lifetime credit spent (sum of charges), USD.

Format"double"
Pattern"^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$"

The page size requested.

Format"int32"
Pattern"^-?(?:0|[1-9]\\d*)$"

Lifetime credit added (sum of confirmed top-ups), USD.

Format"double"
Pattern"^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$"

Total transactions for the owner (for pagination).

Format"int32"
Pattern"^-?(?:0|[1-9]\\d*)$"

True for a whitelisted account (shows "included" rather than a balance).

Playground

Server
Authorization
Variables
Key
Value

Samples

Powered by VitePress OpenAPI