Wallet Manag API

Search…
Wallet Manag API
General API information
The Wallet Manag API that serves for creating and managing Your wallet:
Registration and account management
Cryptocurrency buy/sell orders
Working with external wallets
Ability to update rate information
HTTP Return Codes
HTTP 4XX return codes are used for malformed requests;
the issue is on the sender's side.
HTTP 400 return code is used when the WAF Limit (Web Application Firewall) has been violated.
HTTP 404 return code is used when requested data not found.
HTTP 408 return code is used when request timeout exceeded.
HTTP 5XX return codes are used for internal errors; the issue is on
Zam's side.
It is important to NOT treat this as a failure operation; the execution status is
UNKNOWN and could have been a success.
HTTP 500 return code is used when internal server error occured.
HTTP 503 return code is used when requested service is unreachable.
Error Codes
Any endpoint can return an ERROR
Sample Payload below:
1
{
2
 "meta": {
3
  "status": "OK",
4
  "message": "ERROR - Authorization error"
5
 },
6
 "data": {}
7
}
Copied!
Common response parts
The response always consist of two objects meta and data.
The meta object has two parameters status that could be "OK" or "ERROR" and message with status describtion values: "SUCCESS" "Not found" and etc.. data object will contain either no object or response's payload.
API methods
The API contains wallet management methods such as account administration, ordering transactions, adding/deleting external wallets and etc..
Account management requests
New User registration
New user registration request.
Request type and URL:
1
POST https://zam.io/api/auth
Copied!
Request parameters:
Name
Type
Description
phone
STRING
User’s phone number. Should contain at least 10 characters.
fullName
STRING
User’s full name(Surname, Name, Patronymic/Middle Name).
refCode
STRING
The referral code that user received if was invited.
codeRequest
OBJECT
Subrequest for number verification. Contains “phone” field that was mentioned above.
Request example:
1
    {
2
      "phone": "0647744360",
3
      "fullName": "Name Surname",
4
      "refCode": "{referral code}",
5
      "codeRequest": 
6
      {
7
       "phone": "0647744360"
8
      }
9
    }
Copied!
Response parameters:
Name
Type
Description
passportMessage
STRING
Passport phrase.
agreement
OBJECT
An agreement object that consist of parameters describet below.
id
STRING
UUID of agreement document. Example: 173e4567-e89b-12d3-a456-426624174000.
name
STRING
The agreement file name.
url
STRING
The agreement file's URL.
Response example:
1
    {
2
     "meta": 
3
     {
4
      "status": "OK",
5
      "message": "Success"
6
     },
7
     "data": 
8
     {
9
      "passportMessage": "Passport phrase",
10
      "agreement": 
11
      {
12
       "id": "173e4567-e89b-12d3-a456-426624174000",
13
       "name": "Security agreement",
14
       "url": "/api/auth/documents/173e4567-e89b-12d3-a456-426614174000"
15
      }
16
     }
17
    }
Copied!
Password change
Simple password change request.
Request type and URL:
1
POST https://zam.io/api/auth/change
Copied!
Request parameters:
Name
Type
Description
oldPassword
STRING
Old password's hash.
newPassword
STRING
New password's hash.
Request example:
1
    {
2
     "oldPassword": "839a54bf20626e4942bc8f11873f0654",
3
     "newPassword": "fb29ed3264c5a92bcf74eccd7489e828"
4
    }
Copied!
Response example:
1
    {
2
     "meta": 
3
     {
4
      "status": "OK",
5
      "message": "Success"
6
     }
7
    }
Copied!
Request for security agreements
Security agreement for user to accept.
Request type and URL:
1
 GET https://zam.io/api/auth/documents/:documentId
Copied!
The response returns security agreement file to download.
Delete account
Request to delete authorized account.
Request type and URL:
1
DELETE https://zam.io/api/auth/delete
Copied!
Response example:
1
{
2
 "meta": {
3
  "status": "OK",
4
  "message": "Success"
5
 },
6
 "data": {}
7
}
Copied!
Generate private key
Request for Zam wallet's private key generation
Request type and URL:
1
GET https://zam.io/api/auth/privateKey
Copied!
Response parameters:
Name
Type
Description
privateKey
STRING
Zam wallet's private key.
Response example:
1
{
2
 "meta": {
3
  "status": "OK",
4
  "message": "Success"
5
 },
6
 "data": {
7
  "privateKey": "bd0c8e3bd998a500b0984584a7245ca0"
8
 }
9
}
Copied!
Update token
Request for authorization token.
Request type and URL:
1
POST https://zam.io/api/auth/token
Copied!
Request parameters:
Name
Type
Description
token
STRING
Last expired token.
deviceId
STRING
Device’s UUID.
login
STRING
User’s login.
password
STRING
Hash of user’s password.
Request example:
1
{
2
    "token": "94a08da1fecbb6e8b46990538c7b50b2",
3
    "deviceId": "123e4567-e89b-12d3-a456-426614174000",
4
    "login": "UserName",
5
    "password": "fb29ed3264c5a92bcf74eccd7489e828"
6
}
Copied!
Response parameters:
Name
Type
Description
token
STRING
Last expired token.
agreement
OBJECT
An object with three parameters described.
id
STRING
UUID of agreement document. Example: 173e4567-e89b-12d3-a456-426624174000.
name
STRING
The agreement file name.
url
STRING
The agreement file's URL.
Response example:
1
{
2
 "meta": {
3
  "status": "OK",
4
  "message": "Success"
5
 },
6
 "data": {
7
  "token": "94a08da1fecbb6e8b46990538c7b50b2",
8
  "agreement": {
9
   "id": "173e4567-e89b-12d3-a456-426624174000",
10
   "name": "Security agreement",
11
   "url": "/api/auth/documents/173e4567-e89b-12d3-a456-426614174000"
12
  }
13
 }
14
}
Copied!
Order requests
Request for transaction order generation
Request for transaction order to buy/sell cryptocurrency. Headers of request are described below Here should be table
Request parameters:
Name
Type
Description
Example
priority
STRING
Transaction priority (default value - MEDIUM, optional - TOP).
MEDIUM
blockchainFrom
STRING
Source platform name.
Binance
blockchainTo
STRING
Destination platform name.
Binance
addressContractFrom
STRING
Contract adrress on source wallet.
​
addressContractTo
STRING
Contract address on destiantion wallet.
​
adressFrom
STRING
Soruce wallet address.
cosmos18ta688t40kmped54stvdgvgrazmyh0zqwhmhf5
addressTo
STRING
Destionation wallet address.
12PUTiN2VjQQzkmSNU7AauHNrQSuadbmhH
currency
STRING
Cryptocurrency shortname.
BTC
amount
STRING
Cryptrocurrency amount.
3.45
dateCreate
STRING
Order creation date:time.
1947-04-26T15:41:07.646Z
Request type and URL:
1
GET https://zam.io/api/order?priority=MEDIUM&blockchainFrom=string&blockchainTo=string&addressContractFrom=string&addressContractTo=string&adressFrom=string&addressTo=string&amount=string&paymentRestrictionTransaction=string
Copied!
Response parameters:
Name
Type
Description
blockchainFrom
STRING
Source platform name
blockchainTo
STRING
Destination platform name.
addressTo
STRING
Destionation wallet address.
amount
STRING
Cryptrocurrency amount.
dateCreate
STRING
Order creation date:time.
addressContractFrom
STRING
Contract adrress on source wallet.
addressContractTo
STRING
Contract address on destiantion wallet.
adressFrom
STRING
Soruce wallet address.
currency
STRING
Cryptocurrency shortname.
Response example:
1
{
2
 "meta": {
3
  "status": "OK",
4
  "message": "Success"
5
 },
6
 "data": {
7
  "blockchainFrom": "",
8
  "blockchainTo": "",
9
  "addressTo": "",
10
  "amount": "34.00",
11
  "dateCreate": "1947-04-26T15:41:07.646Z",
12
  "addressContractFrom": "",
13
  "addressContractTo": "",
14
  "adressFrom": "",
15
  "currency": "USD"
16
 }
17
}
Copied!
Order for cryptocurrency buy
The buy operation that follows after receiving transaction order.
Request parameters:
Name
Type
Description
Example
priority
STRING
Transaction priority (default value - MEDIUM, optional - TOP).
MEDIUM
blockchainTo
STRING
Destination platform name.
Binance
addressContractTo
STRING
Contract address on destiantion wallet.
​
addressTo
STRING
Destionation wallet address.
12PUTiN2VjQQzkmSNU7AauHNrQSuadbmhH
currency
STRING
Cryptocurrency shortname.
BTC
amount
STRING
Cryptrocurrency amount.
3.45
dateCreate
STRING
Order creation date:time.
1947-04-26T15:41:07.646Z
order
STRING
Reference to transaction order for payment.
​
Request type and URL:
1
PUT https://zam.io/api/order/purchase?priority=MEDIUM&blockchainTo=string&addressContractTo=string&addressTo=string&amount=string&paymentRestrictionTransaction=string
Copied!
Response parameters:
Name
Type
Description
blockchainTo
STRING
Destination platform name.
addressTo
STRING
Destionation wallet address.
amount
STRING
Cryptrocurrency amount.
dateCreate
STRING
Order creation date:time.
order
STRING
Reference to transaction order for payment.
addressContractTo
STRING
Contract address on destiantion wallet.
currency
STRING
Cryptocurrency shortname.
Response example:
1
{
2
 "meta": {
3
  "status": "OK",
4
  "message": "Success"
5
 },
6
 "data": {
7
  "blockchainTo": "",
8
  "addressTo": "",
9
  "amount": "34.00",
10
  "dateCreate": "1947-04-26T15:41:07.646Z",
11
  "order": "",
12
  "addressContractTo": "",
13
  "currency": "USD"
14
 }
15
}
Copied!
Order for cryptocurrency sell
The sell operation that follows after receiving transaction order. FPS - Fast Payment System
Request type and URL:
1
PUT https://zam.io/api/order/sale?priority=MEDIUM&blockchainFrom=string&blockchainTo=string&addressContractFrom=string&addressContractTo=string&adressFrom=string&addressTo=string&amount=string&paymentRestrictionTransaction=string
Copied!
Request parameters:
Name
Type
Description
spbPhone1
STRING
Phone number registered on FPS.
spbName1
STRING
Full name registered on on FPS.
visaCardNumber2
STRING
16 digit card number.
visaName2
STRING
Fullname of card holder.
masterCardNumber3
STRING
16 digit card number.
bankAccountPaymentAccount4
STRING
​
bankAccountBIK4
STRING
​
bankAccountName4
STRING
​
Request example:
1
{
2
    "spbPhone1": "",
3
    "spbName1": "",
4
    "visaCardNumber2": "0000 0000 0000 0000",
5
    "visaName2": "Name Surname",
6
    "masterCardNumber3": "0000 0000 0000 0000",
7
    "masterName3": "Name Surname",
8
    "bankAccountPaymentAccount4": "",
9
    "bankAccountBIK4": "",
10
    "bankAccountName4": ""
11
}
Copied!
Response parameters:
Name
Type
Description
priority
STRING
Transaction priority (default value - MEDIUM, optional - TOP).
blockchainFrom
STRING
Source platform name.
blockchainTo
STRING
Destination platform name.
addressTo
STRING
Destionation wallet address.
amount
STRING
Cryptrocurrency amount.
dateCreate
STRING
Order creation date:time.
addressContractFrom
STRING
Contract adrress on source wallet.
addressContractTo
STRING
Contract address on destiantion wallet.
adressFrom
STRING
Soruce wallet address.
currency
STRING
Cryptocurrency shortname.
Response example:
1
{
2
 "meta": {
3
  "status": "OK",
4
  "message": "Success"
5
 },
6
 "data": {
7
  "blockchainFrom": "",
8
  "blockchainTo": "",
9
  "addressTo": "",
10
  "amount": "34.00",
11
  "dateCreate": "1947-04-26T15:41:07.646Z",
12
  "addressContractFrom": "",
13
  "addressContractTo": "",
14
  "adressFrom": "",
15
  "currency": "USD"
16
 }
17
}
Copied!
Enable or Disable external wallets
Enable external wallet
Request for adding external wallet.
Request type and URL:
1
POST https://zam.io/api/otherCrypto
Copied!
Request parameters:
Name
Type
Description
blockchain
STRING
Platform name.
addressContract
STRING
Wallet’s contract address.
adress
STRING
Wallet's adress.
Request example:
1
{
2
 "blockchain": "Zam",
3
 "addressContract": "",
4
 "adress": ""
5
}
Copied!
Response example:
1
{
2
 "meta": {
3
  "status": "OK",
4
  "message": "Success"
5
 },
6
 "data": {}
7
}
Copied!
Disable external wallet
Request to disable external wallet. Headers are described below.
Request parameters:
Name
Type
Description
blockchain
STRING
Platform name.
addressContract
STRING
Wallet’s contract address.
adress
STRING
Wallet's adress.
Request type and URL:
1
DELETE https://zam.io/api/otherCrypto?blockchain=string&addressContract=string&address=string
Copied!
Response example:
1
{
2
 "meta": {
3
  "status": "OK",
4
  "message": "Success"
5
 },
6
 "data": {}
7
}
Copied!
Request for rate information
Get top50 cryptocurrenies' information
Request for top 50 crypto currencies with currency to Zam/dollar rate.
Request type and URL:
1
GET https://zam.io/api/rate
Copied!
Response is an object array of currencies' describtions and rate data. Parameters:
Name
Type
Description
blockchain
STRING
Platform name.
address
STRING
Wallet's adress.
currency
STRING
Cryptocurrency shortname.
rateToDollar
STRING
Rate to dollar.
rateToZam
STRING
Rate to Zam.
amount
STRING
Cryptrocurrency amount.
dateCreate
STRING
Date:time of exchange rate actualization.
addressContract
STRING
Wallet’s contract address.
Response example:
1
{
2
 "meta": {
3
  "status": "OK",
4
  "message": "Success"
5
 },
6
 "data": [
7
  {
8
   "blockchain": "BTC",
9
   "address": "",
10
   "currency": "BTC",
11
   "rateToDollar": "100000.00",
12
   "rateToZam": "0.5",
13
   "amount": "34.5",
14
   "dateRate": "1947-04-26T15:41:07.646Z",
15
   "addressContract": ""
16
  },
17
  {
18
   "blockchain": "ETH",
19
   "address": "",
20
   "currency": "BTC",
21
   "rateToDollar": "200",
22
   "rateToZam": "0.005",
23
   "amount": "34.5",
24
   "dateRate": "1947-04-26T15:41:07.646Z",
25
   "addressContract": ""
26
  }
27
 ]
28
}
Copied!
Selected cryptocurrency to dollar rate
Gets rate to dollar. Headers are described below.
Request parameters:
Name
Type
Description
currency
STRING
Cryptocurrency shortname.
blockchain
STRING
Platform name.
addressContract
STRING
Wallet’s contract address.
Request type and URL:
1
GET https://zam.io/api/rate/dollar?currency=string&blockchain=string&addressContract=string
Copied!
Response parameters:
Name
Type
Description
blockchain
STRING
Platform name.
address
STRING
Wallet's adress.
currency
STRING
Cryptocurrency shortname.
rateToDollar
STRING
Rate to dollar.
rateToZam
STRING
Rate to Zam.
amount
STRING
Cryptrocurrency amount.
dateCreate
STRING
Date:time of exchange rate actualization.
addressContract
STRING
Wallet’s contract address.
Response example:
1
{
2
 "meta": {
3
  "status": "OK",
4
  "message": "Success"
5
 },
6
 "data":{
7
  "blockchain": "ETH",
8
  "address": "",
9
  "currency": "BTC",
10
  "rateToDollar": "200",
11
  "rateToZam": "0.005",
12
  "amount": "34.5",
13
  "dateRate": "1947-04-26T15:41:07.646Z",
14
  "addressContract": ""
15
 }
16
}
Copied!
Selected cryptocurrency to Zam rate
Gets rate to Zam. Headers are described below.
Request parameters:
Name
Type
Description
currency
STRING
Cryptocurrency shortname.
blockchain
STRING
Platform name.
addressContract
STRING
Wallet’s contract address.
Request type and URL:
1
GET https://zam.io/api/rate/zam?currency=string&blockchain=string&addressContract=do dipisicing
Copied!
Response parameters:
Name
Type
Description
blockchain
STRING
Platform name.
address
STRING
Wallet's adress.
currency
STRING
Cryptocurrency shortname.
rateToDollar
STRING
Rate to dollar.
rateToZam
STRING
Rate to Zam.
amount
STRING
Cryptrocurrency amount.
dateCreate
STRING
Date:time of exchange rate actualization.
addressContract
STRING
Wallet’s contract address.
Response example:
1
{
2
 "meta": {
3
  "status": "OK",
4
  "message": "Success"
5
 },
6
 "data":{
7
  "blockchain": "ETH",
8
  "address": "",
9
  "currency": "BTC",
10
  "rateToDollar": "200",
11
  "rateToZam": "0.005",
12
  "amount": "34.5",
13
  "dateRate": "1947-04-26T15:41:07.646Z",
14
  "addressContract": ""
15
 }
16
}
Copied!
Amount information
Balance check on all connected wallets
Request for balance information on all enabled wallets.
Request type and URL:
1
GET https://zam.io/api/amount
Copied!
Request is an array of objects that describes wallet data. Parameters:
Response parameters:
Name
Type
Description
blockchain
STRING
Platform name.
address
STRING
Wallet's adress.
currency
STRING
Cryptocurrency shortname.
amount
STRING
Cryptrocurrency amount.
addressContract
STRING
Wallet’s contract address.
Response example:
1
{
2
 "meta": {
3
  "status": "OK",
4
  "message": "Success"
5
 },
6
 "data": [
7
  {
8
   "blockchain": "BTC",
9
   "address": "",
10
   "currency": "BTC",
11
   "amount": "34.56",
12
   "addressContract": ""
13
  },
14
  {
15
   "blockchain": "Zam",
16
   "address": "",
17
   "currency": "Zam",
18
   "amount": "34.56",
19
   "addressContract": ""
20
  }
21
 ]
22
}
Copied!
History
Transaction history for selected wallet
Request type and URL:
1
GET https://zam.io/api/history
Copied!
Response example:
1
{
2
 "meta": {
3
  "status": "OK",
4
  "message": "Success"
5
 },
6
 "data": [
7
  {
8
   "blockchainFrom": "BTC",
9
   "blockchainTo": "Zam",
10
   "addressTo": "",
11
   "amount": "34.56",
12
   "commission": [
13
    {
14
     "paymentTransaction": "",
15
     "commissionTransaction": ""
16
    },
17
    {
18
     "paymentTransaction": "",
19
     "commissionTransaction": ""
20
    }
21
   ],
22
   "dateCreate": "1947-04-26T15:41:07.646Z",
23
   "dateConfirm": "1947-04-26T15:41:07.646Z",
24
   "addressContractFrom": "",
25
   "addressContractTo": "",
26
   "adressFrom": "",
27
   "currency": ""
28
  },
29
  {
30
   "blockchainFrom": "ETH",
31
   "blockchainTo": "Zam",
32
   "addressTo": "",
33
   "amount": "34.56",
34
   "commission": [
35
    {
36
     "paymentTransaction": "",
37
     "commissionTransaction": ""
38
    },
39
    {
40
     "paymentTransaction": "",
41
     "commissionTransaction": ""
42
    }
43
   ],
44
   "dateCreate": "1947-04-26T15:41:07.646Z",
45
   "dateConfirm": "1947-04-26T15:41:07.646Z",
46
   "addressContractFrom": "",
47
   "addressContractTo": "",
48
   "adressFrom": "",
49
   "currency": ""
50
  }
51
 ]
52
}
Copied!
Notifications management
Update notifications
Request type and URL:
1
GET https://zam.io/api/notifications?offset=0&limit=10
Copied!
Response example:
1
{
2
 "meta": {
3
  "status": "OK",
4
  "message": "Success"
5
 },
6
 "data": {
7
  "notifications": [
8
   {
9
    "title": "Money purchase",
10
    "text": "2.1 ETH were purchased to Your wallet (address ...), from address ... в 09:02:57 18.06.2021y.",
11
    "date": "2020-10-05T10:04:07.666Z",
12
    "read": true
13
   },
14
   {
15
    "title": "Money purchase",
16
    "text": "2.1 ETH were purchased to Your wallet (address ...), from address ... в 09:02:57 18.06.2021y.",
17
    "date": "1947-04-26T15:41:07.646Z",
18
    "read": true
19
   }
20
  ],
21
  "pagination": {
22
   "offset": 0,
23
   "limit": 10,
24
   "total": 100
25
  }
26
 }
27
}
Copied!
Calculation requests
Transaction information request
Request to get approximate rate and cost of transaction. Headers are described below.
Request parameters:
Name
Type
Description
Example
priority
STRING
Transaction priority (default value - MEDIUM, optional - TOP).
MEDIUM
blockchainFrom
STRING
Source platform name.
Binance
blockchainTo
STRING
Destination platform name.
Binance
addressContractFrom
STRING
Contract adrress on source wallet.
​
addressContractTo
STRING
Contract address on destiantion wallet.
​
adressFrom
STRING
Soruce wallet address.
cosmos18ta688t40kmped54stvdgvgrazmyh0zqwhmhf5
addressTo
STRING
Destionation wallet address.
12PUTiN2VjQQzkmSNU7AauHNrQSuadbmhH
currency
STRING
Cryptocurrency shortname.
BTC
amount
STRING
Cryptrocurrency amount.
3.45
paymentRestrictionTransaction
STRING
Payment limit for transaction.
5.147
Request type and URL:
1
GET https://zam.io/api/calculation?priority=MEDIUM&blockchainFrom=string&blockchainTo=string&addressContractFrom=string&addressContractTo=string&adressFrom=string&addressTo=string&amount=string&paymentRestrictionTransaction=string
Copied!
Response example:
1
{
2
 "meta": {
3
  "status": "OK",
4
  "message": "Success"
5
 },
6
 "data": {
7
  "blockchainFrom": "",
8
  "blockchainTo": "",
9
  "addressTo": "",
10
  "amount": "",
11
  "commission": [
12
   {
13
    "paymentTransaction": 