v1

latestOpenAPI 3.0.02026-08-04134348905.1 KB
Deposit Attribution

List deposit attributions

Permissions required: Read Deposit Attribution or Deposit Attribution.

Returns all Deposit Attributions for an Organization based on the provided query parameters.

Default sorting will be ascending order by createdAt.

get/deposit-attributions/attributions

Query parameters

afterIdstring

When paginating this is used to provide the starting point for the page to fetch (retrieved from the previous response body).

limitinteger

Maximum number of results to return per query.

status'ATTRIBUTED' | 'PENDING' | 'UNDER_REVIEW' | 'BLOCKED' | 'NON_ATTRIBUTABLE' | 'INITIATED'

Filter by pending or attributed deposits.

startDateTimestring date-time

The start date-time (exclusive) of the deposit attribution process in UTC following RFC 3339 'date-time' format. A valid format example is 2021-01-01T00:00:00.000000Z.

endDateTimestring date-time

The end date-time (exclusive) to consider the start of the deposit attribution process in UTC following RFC 3339 'date-time' format. A valid format example is 2021-01-01T00:00:00.000000Z.

attributedAtStartDateTimestring date-time

The start date-time (exclusive) to consider the attribution date of the deposit in UTC following RFC 3339 'date-time' format. A valid format example is 2021-01-01T00:00:00.000000Z.

attributedAtEndDateTimestring date-time

The end date-time (exclusive) to consider the attribution date of the deposit in UTC following RFC 3339 'date-time' format. A valid format example is 2021-01-01T00:00:00.000000Z.

subaccountIdsstring[]

Filter results to deposits associated with the specified subaccounts. Multiple values may be provided.

Response

Success

Example response

{
  "data": [
    {
      "assetType": "ETH",
      "attributedAt": "2023-07-27T21:16:44.124798Z",
      "attributionType": "CLIENT_API",
      "blockchainTxId": "0x84ddb76708d570101db89fd27b1717484c54417c9f32c63052cdfac9a0bfc0a2",
      "createdAt": "2023-09-12T11:01:07.953571Z",
      "depositTransactionId": "0e2b2f9d-8d10-4f1e-960b-28567255045f",
      "originatorCountry": "US",
      "originatorName": "John Doe",
      "sourceAddresses": [
        "0xb4Bb4E3D7f35ede58d99F5e2b8B04f7AC87f9c88",
        "0x974CaA59e49682CdA0AD2bbe82983419A2ECC400"
      ],
      "subaccountId": "ec761b5e-fd2c-497a-a9a0-f8738ac97bdf"
    }
  ],
  "page": {
    "next": "<next page url>"
  }
}