Sign in

v1

latestOpenAPI 3.0.02026-07-2656110201.6 KB
Deposits

Get Deposit Customer Activity

Returns a paginated list of deposit transaction activity for a deposit customer, identified by their deposit customer token. Each item summarises a single deposit: amounts sent/received (in minimal units, as strings), the source and destination networks, the current status, and the delivery time once settled.

Authentication: none (public). The deposit customer token in the path is the credential — keep it secret as you would an API key.

get/v1/deposit-customers/{depositCustomerToken}/activity

Path parameters

depositCustomerTokenstring required

The token associated with the deposit customer whose activity is being retrieved.

Query parameters

transactionStatus'INITIATED' | 'PENDING' | 'BRIDGING' | 'SUCCESS' | 'FAILED' | 'CANCELED' | 'SETTLED' | 'REFUNDED'

Filter activity by transaction status.

pagenumber

Page number to retrieve (1-based).

limitnumber

Number of items per page.

lastItemIdstring

Cursor for keyset pagination: the id of the last item from the previous page.

sortstring

Field to sort by.

orderstring

Sort order, e.g. asc or desc.

searchstring

Free-text search filter.

startDatestring

Start of the time range, in ISO 8601 format.

endDatestring

End of the time range, in ISO 8601 format.

Response

Paginated deposit customer activity.

totalnumber

Total number of activity items matching the query.

pagenumber

Current page number.

limitnumber

Page size used for this response.