v1

latestOpenAPI 3.0.02026-07-26117198177.4 KB
Network Information

Get all payments by network

Returns a list of payments for the specified network. Supports both traditional pagination and scroll API for large datasets.

post/v1/network/{network}/payments

Path parameters

networkstring required

Query parameters

pagestring
Example:0

Page number "offset"

pageSizestring

Page size

useScrollboolean

Whether to use scroll API for pagination

scrollBatchSizenumber

Batch size for scroll requests

hasMoreboolean

Whether there are more results available (only when useScroll=true)

keystring required

Key for the address parameter

valuestring required

Value for the address parameter

Array of address parameters

direction'incoming' | 'outgoing'

Direction of payment (incoming, outgoing) default is both

sort'asc' | 'desc'

Sort order (asc, desc)

groupBy'address' | 'entity'

"address" mode or "entity" mode

startTimestring

Start time

endTimestring

End time

sortBy'ti' | 'usd'

Sort By Field

msgTypesstring[]

Array of message types

senderSymbolsstring

sender symbols seperated by comma

Request body

scrollIdstring

Scroll ID for pagination (only when useScroll=true)

Response

List of payments for the specified network.

scrollIdstring

Scroll ID for pagination (only when useScroll=true)

hasMoreboolean

Whether there are more results available (only when useScroll=true)

paymentsobject[] required

Array of payment objects

countnumber

Total count of payments (only in initial request or traditional pagination)