We refreshed our doc site!
Bookmarked links may have changed
Read release notes
List all payouts
GEThttps://api.circle.com/v1/payouts
Query parameters
source
string
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
uuid
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
array
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
array
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
date-time
Queries items created since the specified date-time (inclusive).
to
date-time
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
integer
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.
Response
RequestChoose a language
ResponseChoose an example
1{
2 "data": [
3 {
4 "id": "b8627ae8-732b-4d25-b947-1df8f4007a29",
5 "sourceWalletId": "53535335",
6 "destination": {
7 "type": "address_book",
8 "id": "b8627ae8-732b-4d25-b947-1df8f4007a29"
9 },
10 "amount": {
11 "amount": "3.14",
12 "currency": "USD"
13 },
14 "toAmount": {
15 "amount": "3.14",
16 "currency": "USD"
17 },
18 "fees": {
19 "amount": "3.14",
20 "currency": "USD"
21 },
22 "networkFees": {
23 "amount": "3.14",
24 "currency": "USD"
25 },
26 "status": "pending",
27 "errorCode": "insufficient_funds",
28 "riskEvaluation": {
29 "decision": "approved",
30 "reason": "3000"
31 },
32 "createDate": "2020-04-10T02:13:30.000Z",
33 "updateDate": "2020-04-10T02:13:30.000Z"
34 }
35 ]
36}Did this page help you?
© 2023-2024 Circle Technology Services, LLC. All rights reserved.
