API Reference
Client PortalAPI StatusWebsite

List payouts.

get
https://www.bankingcircleconnect.com/api/v1/digital-assets/payouts
Query Params
statuses
array of objects

Filter payouts by lifecycle status (Pending, Completed, Failed). Omit to include all statuses.

statuses
Allowed:
networkAssetCodes
array of objects

Filter payouts by network + asset code. Omit to include all network asset codes.

networkAssetCodes
Allowed:
profileIds
array of objects

Filter payouts by owning profile id. Omit to include all profiles.

profileIds
addressIds
array of objects

Filter payouts by destination address id. Omit to include all addresses.

addressIds
date-time

Inclusive lower bound on payout creation time (RFC 3339).

date-time

Inclusive upper bound on payout creation time (RFC 3339).

int32 | int32
1 to 5000
^-?(?:0|[1-9]\d*)$

Max number of records to return on the initial page. Must be bigger than 0 and less than or equal to 5000. Default is 100. Cannot be used together with cursor.

enum

Order of records on the initial page. Cannot be used together with cursor.

Allowed:
string
length between 1 and 512
^[A-Za-z0-9_=\-]+$

Cursor from a previous response used to fetch the next or previous page. Cannot be used with any other parameters except direction.

enum

Traversal direction when using cursor. Required when using cursor.

Allowed:
Responses

Updated 2 days ago

Did this page help you?
Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 2 days ago

Did this page help you?