Sign in
latestOpenAPI 3.0.32026-08-224982,0272.8 MB

e445c15e5bee

Transfer

List all transfers on all wallets in an enterprise

Returns all the transfers without blockchain information (inputs, outputs, confirms). Use the coin specific route to annotate blockchain information.

get/api/v2/enterprise/{enterpriseId}/transfer

Path parameters

enterpriseIdstring required
Example:59cd72485007a239fb00282ed480da1f

The enterprise ID

Query parameters

coinCoin[]

Filter by coin

[
  "btc"
]
dateGtestring date-time
Example:2025-01-01T00:00:00.000Z

Return transfers with a date that is greater than or equal to the given timestamp

dateLtstring date-time
Example:2025-03-28T00:00:00.000Z

Return transfers with a date that is less than the given timestamp

limitinteger

Maximum number of results to return. If the result set is truncated, use the nextBatchPrevId value to get the next batch.

prevIdstring
Example:59cd72485007a239fb00282ed480da1f

Return the next batch of results, based on the nextBatchPrevId value from the previous batch.

stateTransferState[]

The status of the transfer. • confirmed indicates the transaction is confirmed on chain. • failed indicates the transaction failed. initialized is the first state of a transaction and indicates the transaction is initialized. • pendingApproval indicates the transaction is initialized and pending approval. • rejected indicates the transaction was rejected by an approver. • removed indicates the transaction was reorganized from the mempool (it's still possible recieve confirmation in another block). • replaced indicates the transaction was replaced with a new transaction with higher fees. • signed indicates the transaction is signed and pending on-chain confirmation. • unconfirmed indicates the transaction is pending on-chain confirmation.

[
  "confirmed"
]
type'send' | 'receive'

Filter on sending or receiving Transfers

sortBy'heightId' | 'id' | 'date'

Sorts by specified field, default sorting by heightId.

sortDirection'ASC' | 'DESC'

Sorts order by field in specified sort direction, default ascending.

idstring
Example:59cd72485007a239fb00282ed480da1f

Filter for a transfer by one or more transfer ids

addressAddressString3[]

Return transfers with elements in entries that have an address field set to this value

[
  "2MvrwRYBAuRtPTiZ5MyKg42Ke55W3fZJfZS"
]
txidstring

Return transfers with a matching 'txid'

Response

OK

nextBatchPrevIdstring uuid

When a result set is truncated, this field returns the id of the last object in the previous batch. To get the next batch of results, pass this value via the prevId query parameter.

Example response

{
  "transfers": [
    {
      "coin": "btc",
      "id": "59cd72485007a239fb00282ed480da1f",
      "wallet": "59cd72485007a239fb00282ed480da1f",
      "enterprise": "59cd72485007a239fb00282ed480da1f",
      "txid": "b8a828b98dbf32d9fd1875cbace9640ceb8c82626716b4a64203fdc79bb46d26",
      "normalizedTxHash": "b8a828b98dbf32d9fd1875cbace9640ceb8c82626716b4a64203fdc79bb46d26",
      "valueString": "2000000",
      "intendedValueString": "2000000",
      "baseValueString": "2000000",
      "baseValueWithoutFeesString": "2000000",
      "state": "confirmed",
      "tags": [
        "59cd72485007a239fb00282ed480da1f"
      ],
      "history": [
        {
          "user": "59cd72485007a239fb00282ed480da1f"
        }
      ],
      "consolidateId": "59cd72485007a239fb00282ed480da1f",
      "entries": [
        {
          "address": "2NAUwNgXaoFj2VVnSEvNLGuez8CfdU2UCMZ",
          "wallet": "59cd72485007a239fb00282ed480da1f",
          "valueString": "2000000",
          "token": "omg"
        }
      ]
    }
  ],
  "nextBatchPrevId": "585951a5df8380e0e3063e9f"
}