Skip to main content
POST
/
v3
/
api
/
custody
/
transactions
Retrieve transactions
curl --request POST \
  --url https://api.custody.api-zodia.io/v3/api/custody/transactions \
  --header 'Content-Type: application/json' \
  --header 'X-Signature: <api-key>' \
  --header 'submitter-id: <submitter-id>' \
  --data '
{
  "walletIds": [
    "ZTEST-NOBENF-W5NZ2XCZMF"
  ],
  "destinations": [
    "ZTEST-NOBENF-W5NZ2XCZMF"
  ],
  "statuses": [
    "PENDING CONFIRMATION"
  ],
  "currencies": [
    "ETH"
  ],
  "currenciesIds": [
    "eth-eth"
  ],
  "amounts": [
    "10000"
  ],
  "ledgerRefs": [
    "0x77ac045b10bb3f09a8efff110ddfb3280c2bb084"
  ],
  "companyIds": [
    "ZTEST"
  ],
  "fromDate": "2021-05-11T04:43:43Z",
  "toDate": "2021-05-11T04:43:43Z",
  "paginationLimit": 100,
  "paginationOffset": 123,
  "sort": {
    "by": "id",
    "order": "ASC"
  }
}
'
{
  "total": 123,
  "items": [
    {
      "id": "TRI-ZTEST-63Q4DZ0KJP",
      "status": "PENDING_UNLOCK",
      "method": "TRANSFER",
      "type": "INCOMING",
      "sender": {
        "type": "WALLETID",
        "value": "ZTEST-12345678",
        "addresses": [
          "0x05bbb2996fc1eaf2daad914198c02fe9a2b21c73"
        ]
      },
      "destination": {
        "type": "WALLETID",
        "value": "ZTEST-12345678",
        "addresses": [
          "0x05bbb2996fc1eaf2daad914198c02fe9a2b21c73"
        ]
      },
      "currency": "ETH",
      "currencyId": "eth-Seth",
      "ratio": "1000000000000000000",
      "network": "Ethereum",
      "amount": "6,414",
      "amountLedger": "641400",
      "ledgerRef": "2f6e77f8c4313d0925f71acf19a659398115bdf903e3af06b3b1776e756c096f",
      "companyId": "ZTEST",
      "createdAt": "2021-05-11T04:43:43Z",
      "feeAmountLedger": "641400"
    }
  ]
}

Authorizations

X-Signature
string
header
required

Headers

submitter-id
string
required

Email of API user submitting the request

Example:

"api-maker@zodia.io"

Body

application/json
walletIds
string[]

Search by wallet IDs

destinations
string[]

Search by destination values. Acceptable values are wallet ID, beneficiary/self address ID, Fireblocks connection ID and LNURL

statuses
string[]

Search by transfer status. Refer to section Status Reference for list of statuses

currencies
string[]

Search by currencies

currenciesIds
string[]

Search by currency Ids

amounts
string[]

Search transactions by ledger amounts

ledgerRefs
string[]

Search by transaction hash

companyIds
string[]

Search by company IDs

fromDate
string<date-time>

Search from a given date. Datetime format in ISO 8601

Example:

"2021-05-11T04:43:43Z"

toDate
string<date-time>

Search to a given date. Datetime format in ISO 8601

Example:

"2021-05-11T04:43:43Z"

paginationLimit
number

Number of items in response (default is 10)

Example:

100

paginationOffset
number
sort
object

Response

OK

total
integer
required
items
object[]
required

List of transactions