Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.zodia-custody.com/llms.txt

Use this file to discover all available pages before exploring further.

Trading venues need to follow the steps below.

​
Setup Steps

  1. Complete the company onboarding process. Refer to Company Onboarding For API Interaction.
  2. Add API users to the company. Refer to Onboarding API Users.

​
Settlement

Settlement flow Settlement is the transfer of funds between different parties (buyers and sellers) after a trade is executed.
  • Settlement Receivable: Transferring funds from a client’s trading wallet to a venue.
  • Settlement Payable: Transferring funds from a venue to a client’s trading wallet.

​
Instruct a Settlement

Create a service request to instruct a settlement, then submit and approve as described in Instruct a Transfer. 
curl --request POST 'https://hostname.zodia.io/v3/api/servicedesk/create' \
--header 'Content-Type: application/json' \
--data-raw '{
  "serviceId": "0x0003-003",
  "payload": {
    "sender": {
      "type": "WALLETID | WALLETREFERENCE",
      "value": "ZODCS-NOBENF-E3WB8MB4EI"
    },
    "destination": {
      "type": "ENDPOINT | WALLETID | WALLETREFERENCE",
      "value": "467f0fbf-7cd0-4196-b8be-7a33ac66f4f6"
    },
    "currency": "<ETH | BTC | ...>",
    "venueId": "<VENUE_ID>",
    "amount": "100",
    "subtractFee": false
  }
}'

​
Batch Transactions

Batch transactions are supported for settlements on UTXO-based currencies like Bitcoin. 
curl --request POST 'https://hostname.zodia.io/v3/api/servicedesk/create' \
--header 'Content-Type: application/json' \
--data-raw '{
  "serviceId": "0x0003-003",
  "payload": {
    "sender": {
      "type": "WALLETID | WALLETREFERENCE",
      "value": "ZODCS-NOBENF-E3WB8MB4EI"
    },
    "destinations": [
      {
        "type": "ENDPOINT | WALLETID | WALLETREFERENCE",
        "value": "467f0fbf-7cd0-4196-b8be-7a33ac66f4f6"
      },
      {
        "type": "ENDPOINT | WALLETID | WALLETREFERENCE",
        "value": "467f0fbf-7cd0-4196-b8be-ft6tfuy7676"
      }
    ],
    "currency": "<ETH | BTC | ...>",
    "venueId": "<VENUE_ID>",
    "amount": "100",
    "subtractFee": false
  }
}'
What is a batch transaction? Transaction batching combines multiple transactions into a single transaction to save on gas fees and improve efficiency on the blockchain.