We refreshed our doc site!
Bookmarked links may have changed
Read release notes
List all payouts
GEThttps://api.circle.com/v1/businessAccount/payouts
Query parameters
destination
uuid
Universally unique identifier (UUID v4) for the destination bank account. Filters the results to fetch all payouts made to a destination bank account.
type
string
Destination bank account type. Filters the results to fetch all payouts made to a specified destination bank account type. This query parameter can be passed multiple times to fetch results matching multiple destination bank account types.
status
array
Queries items with the specified status. Matches any status 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": "wire",
8 "id": "b8627ae8-732b-4d25-b947-1df8f4007a29",
9 "name": "COMMERZBANK AG ****3000"
10 },
11 "amount": {
12 "amount": "3.14",
13 "currency": "USD"
14 },
15 "toAmount": {
16 "amount": "3.14",
17 "currency": "USD"
18 },
19 "fees": {
20 "amount": "3.14",
21 "currency": "USD"
22 },
23 "status": "pending",
24 "errorCode": "insufficient_funds",
25 "riskEvaluation": {
26 "decision": "approved",
27 "reason": "3000"
28 },
29 "adjustments": {
30 "fxCredit": {
31 "amount": "3.14",
32 "currency": "USD"
33 },
34 "fxDebit": {
35 "amount": "3.14",
36 "currency": "USD"
37 }
38 },
39 "return": {
40 "id": "b8627ae8-732b-4d25-b947-1df8f4007a29",
41 "payoutId": "abdb500d-4a59-457c-801f-2d418c8703ac",
42 "amount": {
43 "amount": "3.14",
44 "currency": "USD"
45 },
46 "fees": {
47 "amount": "3.14",
48 "currency": "USD"
49 },
50 "reason": "payout_returned",
51 "status": "pending",
52 "createDate": "2020-04-10T02:13:30.000Z",
53 "updateDate": "2020-04-10T02:13:30.000Z"
54 },
55 "createDate": "2020-04-10T02:13:30.000Z",
56 "updateDate": "2020-04-10T02:13:30.000Z"
57 }
58 ]
59}Did this page help you?
© 2023-2024 Circle Technology Services, LLC. All rights reserved.
