Skip to main content
POST
/
v3
/
api
/
trading
/
transactions
Retrieve transactions
curl --request POST \
  --url https://api.custody.api-zodia.io/v3/api/trading/transactions \
  --header 'Content-Type: application/json' \
  --header 'X-Signature: <api-key>' \
  --header 'submitter-id: <submitter-id>' \
  --data '
{
  "ids": [
    "<string>"
  ],
  "walletIds": [
    "<string>"
  ],
  "statuses": [
    "<string>"
  ],
  "currencies": [
    "<string>"
  ],
  "amounts": [
    "<string>"
  ],
  "ledgerRefs": [
    "<string>"
  ],
  "companyIds": [
    "<string>"
  ],
  "paginationLimit": 123,
  "paginationOffset": 123,
  "sort": {
    "by": "id",
    "order": "ASC"
  }
}
'
{
  "total": 123,
  "items": [
    {
      "id": "TRI-ZTEST-63Q4DZ0KJP",
      "status": "<string>",
      "method": "<string>",
      "sender": {
        "type": "ADDRESS",
        "value": "ZTEST-11111111",
        "addresses": [
          "tb1qtx38mjl8gyg9gjk58tw88upytxwyxhmcqsv3le"
        ]
      },
      "destination": {
        "type": "ADDRESS",
        "value": "<string>",
        "addresses": [
          "tb1qtx38mjl8gyg9gjk58tw88upytxwyxhmcqsv3le"
        ]
      },
      "destinations": [
        {
          "type": "ADDRESS",
          "value": "<string>",
          "beneficiary": "<string>",
          "name": "<string>",
          "address": "<string>",
          "amount": "<string>",
          "substractFee": true
        }
      ],
      "currency": "<string>",
      "amount": "6,414",
      "amountLedger": "641400",
      "ledgerRef": "2f6e77f8c4313d0925f71acf19a659398115bdf903e3af06b3b1776e756c096f",
      "companyId": "ZTEST",
      "venueId": "<string>",
      "createdAt": "2021-05-11T04:43:43Z"
    }
  ]
}

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
ids
string[]

Search by transaction IDs

walletIds
string[]

Search by wallet IDs

statuses
string[]

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

currencies
string[]

Search by currencies

amounts
string[]

Search transactions by ledger amounts

ledgerRefs
string[]

Search by transaction hash

companyIds
string[]

Search by company IDs. If you are a venue use this field to filter per client

paginationLimit
number

Number of items in response (default is 10)

paginationOffset
number
sort
object

Response

OK

total
integer
items
object[]

List of transactions. Result set will vary depending if you are a venue or a client