ZixiPay API Version 2

General API Information

Error Response:

{
  "result":"",
  "payload":"here will be the reason"
}

Endpoints Limit

Rate and IP Limit

Parameter Value
currency BTC
User ID kkdyrcuxj9jvc6f76fgw
API Key Dq7MRukyFMxvs33944gsrsBGLLThVUQPqcScMJGv
Timestamp 1587228352

Unix Shell

Example of sending a valid signed payload from the Linux command line using echo, openssl and curl.

Parameters:

Name Type Mandatory Description
uid string YES User ID
ts number YES Unix time
sig string YES HMAC-SHA256 signature

Response:

{
  "result":"ok",
  "payload":[           // array of wallets
    {
      "name":"Zixi Dollar",     // currency name
      "code":"USDZ",            // currency symbol
      "balance":"0.00"          // available balance
    },
    {
      "name":"Zixi Euro",
      "code":"EURZ",
      "balance":"0.00"
    },
    {
      "name":"Litecoin",
      "code":"LTC",
      "balance":"0.00000000"
    },
    {
      "name":"Bitcoin",
      "code":"BTC",
      "balance":"0.00000000"
    },
    {
      "name":"Ethereum",
      "code":"ETH",
      "balance":"0.00000000"
    },
    {
      "name":"Tether",
      "code":"USDT",
      "balance":"0.00"
    }
  ]
}

getwallet

POST /apiv2/getwallet

Get wallet address

Parameters:

Name Type Mandatory Description
currency string YES Any of the supported currencies (USDZ, EURZ, LTC, BTC, ETH or USDT)
uid string YES User ID
ts number YES Unix time
sig string YES HMAC-SHA256 signature

Response:

{
  "result":"ok",
  "payload":[
    {
      "name":"Tether OMNI",   // wallet name
      "code":"USDT",          // currency symbol
      "address":"1PkYiGCF3zVif5vm1ogXYuvtGaK3p7qLgK", // wallet address
      "confirm":1             // number of confirmations required
    },
    {
      "name":"Tether ERC20",
      "code":"USDT",
      "address":"0x0ed8991afc868c45ffbcd4afdf7ebc273cf38ed2",
      "confirm":3
    }
  ]
}

getrates

POST /apiv2/getrates

Get live exchange rates

Parameters:

Name Type Mandatory Description
uid string YES User ID
ts number YES Unix time
sig string YES HMAC-SHA256 signature

Response:

{
  "result":"ok",
  "payload":[         // array of currencies
    {
      "code":"USDZ",    // currency code
      "decimal":"2",    // number of decimal digits
      "rate":"1.00"     // exchange rate
    },
    {
      "code":"EURZ",
      "decimal":"2",
      "rate":"1.09"
    },
    {
      "code":"LTC",
      "decimal":"8",
      "rate":"43.71"
    },
    {
      "code":"BTC",
      "decimal":"8",
      "rate":"7239.00"
    },
    {
      "code":"ETH",
      "decimal":"8",
      "rate":"183.91"
    },
    {
      "code":"USDT",
      "decimal":"2",
      "rate":"1.00"
    }
  ]
}

statement

POST /apiv2/statement

Get transaction(s) history with optional filters. Maximum number of transactions returned is 100.

Parameters:

Name Type Mandatory Description
txid string NO ZixiPay transaction ID
timefrom string NO from date in YYYY-MM-DD format
timeto string NO to date in YYYY-MM-DD format
currency string NO Any of the supported currencies (USDZ, EURZ, LTC, BTC, ETH or USDT)
status string NO Transaction status (pending, processed, cancelled or blocked)
type string NO Transaction type (deposit, withdrawal, transfer, exchange or payment)
sender string NO sender, could be user id or email address
recipient string NO recipient, could be user id, email address or crypto wallet address
uid string YES User ID
ts number YES Unix time
sig string YES HMAC-SHA256 signature

Response:

{
  "result":"ok",
  "payload":{
    "records":1,        // number of records
    "transactions":[    // array of transactions
      {
        "txid":"TD4598653469096786",    // ZixiPay transaction id
        "time":"2020-02-17 14:21:32",   // date and time of the transaction
        "type":"deposit",               // type of the transaction
        "status":"processed",           // status of the transaction
        "amount":"218.54",              // amount of the transaction
        "fee":"0.00",                   // fee of the transaction
        "currency":"USDT",              // currency of the transaction
        "sender":"Tether",              // sender
        "recipient":"My Wallet",        // recipient
        "details":""                    // transaction details
      }
    ]
  }
}

Transactional Endpoints

withdraw

POST /apiv2/withdraw

Withdraw any of the supported cryptocurrencies

Parameters:

Name Type Mandatory Description
amount number YES amount to be withdrawn
currency string YES Any of the supported currencies (USDZ, EURZ, LTC, BTC, ETH or USDT)
recipient string YES recipient wallet address
uid string YES User ID
ts number YES Unix time
sig string YES HMAC-SHA256 signature

Response:

{
  "result":"ok",
  "payload":[
    {
      "amount":"1500.00",           // amount of withdrawal
      "fee":"1.00",                 // processing fee
      "total":"1501.00",            // total
      "currency":"USDT",            // currency
      "status":"pending",           // status
      "txid":"TW6596823102569846"   // ZixiPay transaction ID
    }
  ]
}

transfer

POST /apiv2/transfer

Internal transfer any of the supported cryptocurrencies

Parameters:

Name Type Mandatory Description
amount number YES amount to be transferred
currency string YES Any of the supported currencies (USDZ, EURZ, LTC, BTC, ETH or USDT)
recipient string YES recipient email address or user id
note string NO internal comment for the transfer
passcode number NO 4 digit pin if the transfer needs to be passcode protected
uid string YES User ID
ts number YES Unix time
sig string YES HMAC-SHA256 signature

Response:

{
  "result":"ok",
  "payload":[
    {
      "recipient":"somebody@anybody.com",   // recipient
      "amount":"100.00",                    // amount
      "fee":"0.50",                         // processing fee
      "currency":"USDT",                    // currency
      "status":"processed",                 // transaction status
      "txid":"TT2369512364598756",          // ZixiPay transaction id
      "passcode":""                         // transaction passcode
    }
  ]
}