List all payouts
GET {{baseUrl}}/v1/payouts
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
source | number | Identifier for the source wallet. Filters the fetched payout results to only be from a specific source wallet. If not provided, payouts from all wallets will be returned. | |
destination | string | Universally unique identifier (UUID v4) for the destination. Filters the fetched payout results made to a specific destination. If not provided, payouts to all destinations will be returned. | |
type | string | Destination type. Filters the results to fetch all payouts made to a specified destination type. This query parameter can be passed multiple times to fetch results matching multiple destination types. The address_book destination type cannot be combined with other types. | |
status | string | Queries items with the specified status. Matches any status if unspecified. | |
status | string | Queries items with the specified status. Matches any status if unspecified. | |
sourceCurrency | string | Queries items with the specified source currency amount.currency. Matches any source currency if unspecified. | |
destinationCurrency | string | Queries items with the specified destination currency toAmount.currency. Matches any destination currency if unspecified. | |
chain | string | Queries items with the specified chain. Matches any chain if unspecified | |
from | string | Queries items created since the specified date-time (inclusive). | |
to | string | Queries items created before the specified date-time (inclusive). | |
pageBefore | string | A collection ID value used for pagination. |
It marks the exclusive end of a page. When provided, the collection resource will return the next n items before
the id, with n being specified by pageSize.
The items will be returned in the natural order of the collection.
The resource will return the first page if neither pageAfter nor pageBefore are specified.
SHOULD NOT be used in conjuction with pageAfter.
|
| pageAfter | string | | A collection ID value used for pagination.
It marks the exclusive begin of a page. When provided, the collection resource will return the next n items after
the id, with n being specified by pageSize.
The items will be returned in the natural order of the collection.
The resource will return the first page if neither pageAfter nor pageBefore are specified.
SHOULD NOT be used in conjuction with pageBefore.
|
| pageSize | number | | Limits the number of items to be returned.
Some collections have a strict upper bound that will disregard this value. In case the specified value is higher than the allowed limit, the collection limit will be used.
If avoided, the collection will determine the page size itself. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"data":[{"id":"6e2e451e-a3f9-4856-a8e0-d60a990c754e","destination":{"type":"address_book","id":"2b9f9ed9-ac9d-5f6e-954b-a29e03ee3259"},"amount":{"amount":"2.00","currency":"USD"},"toAmount":{"amount":"0.001072542798315455","currency":"ETH"},"createDate":"2024-01-17T21:40:41.425184Z","updateDate":"2024-01-17T21:43:54.407079Z","sourceWalletId":"1000594146","fees":{"amount":"0.01","currency":"USD"},"status":"complete"},{"id":"154e9724-2f07-42d7-87a6-7afbac92d06e","destination":{"type":"address_book","id":"2b9f9ed9-ac9d-5f6e-954b-a29e03ee3259"},"amount":{"amount":"3001.00","currency":"USD"},"toAmount":{"currency":"ETH"},"createDate":"2024-01-17T21:39:51.687286Z","updateDate":"2024-01-17T21:39:57.178871Z","sourceWalletId":"1000594146","status":"pending"}]}