Api Documents - Accept Coin Payments

1) Check account balance

To get balances of your crypto wallets.

URL	https://api.coingateway.io
POST	https://api.coingateway.io/service/wallet/balance
token
currency
	Make Request

Sample Request

curl -X POST "https://api.coingateway.io/service/wallet/balance" \
     --data 'token={access_token}&currency=BTC'

Sample Result

{
  "result": "ok",
  "data": {
    "credits": 2649,
    "list": [
      {
        "currency": "BTC",
        "balance": "2.80218299",
        "unverified": "0.00000000",
        "payment_fee": "0.00100000",
        "pool_fee": "0.00050000",
        "income_fee": "0.00",
        "outcome_fee": "0.00"
      },
      {
        "currency": "DASH",
        "balance": "77.10249480",
        "unverified": "7.00000000",
        "payment_fee": "0.00100000",
        "pool_fee": "0.00050000",
        "income_fee": "0.00",
        "outcome_fee": "0.00"
      }      
    ]
  }
}

2) Check transactions

To get incoming transactions to your wallets.

URL	https://api.coingateway.io
POST	https://api.coingateway.io/service/transaction/get
token
currency
transaction_id
wallet_id
referance
max_id
min_id
limit
	Make Request

Sample Request

curl -X POST "https://api.coingateway.io/service/transaction/get" \
     --data 'token={access_token}&currency=BTC&transaction_id=24'

Sample Result

{
  "result": "ok",
  "data": [
    {
      "id": "24",
      "transaction": "bd357c7301b5e307f3f4ea49eb4f2d757484c9a2e826bff404d71d2f772c300f",
      "wallet_id": "1000001050000000033",
      "referance": "33",
      "currency": "DASH",
      "amount": "5.00000000",
      "commission": "0.00000000",
      "confirmations": "0",
      "time": "1542289967",
      "status": "waiting"
    },
    {
      "id": "23",
      "transaction": "c004ba9933fdb93da9ad48679623e2ea7beae1fdb1f4690c3c0de790a5472bc8",
      "wallet_id": "1000001040000000002",
      "referance": "2",
      "currency": "LTC",
      "amount": "1.20000000",
      "commission": "0.01200000",
      "confirmations": "3",
      "time": "1542289516",
      "status": "confirmed"
    }
  ]
}

3) Check notifications

To get notifications which comes to your website notification url incase you can not catch them.

URL	https://api.coingateway.io
POST	https://api.coingateway.io/service/notification/get
token
last_id
	Make Request

Sample Request

curl -X POST "https://api.coingateway.io/service/notification/get" \
     --data 'token={access_token}&last_id=1'

Sample Result

{
  "result": "ok",
  "data": [
    {
      "id": "1",
      "time": "1542299508",
      "notification": "[{\"type\":\"payment\",\"id\":31,\"currency\":\"BTC\",\"amount\":\"0.22000000\",\"transaction\":\"02a4c59fa7a4135dbcd6d3a664b4ad403e5cc91c12eece57ff9b124a95031ff7\",\"sent\":1542299508},{\"type\":\"payment\",\"id\":\"30\",\"currency\":\"BTC\",\"amount\":\"0.30000000\",\"transaction\":\"02a4c59fa7a4135dbcd6d3a664b4ad403e5cc91c12eece57ff9b124a95031ff7\",\"sent\":1542299508}]",
      "status": "waiting"
    },
    {
      "id": "2",
      "time": "1542300062",
      "notification": "[{\"type\":\"txinsert\",\"transaction\":\"02a4c59fa7a4135dbcd6d3a664b4ad403e5cc91c12eece57ff9b124a95031ff7\",\"id\":\"28\",\"wallet_id\":\"1000001010000000001\",\"referance\":1,\"currency\":\"BTC\",\"amount\":\"0.22000000\",\"confirmation\":\"0\",\"status\":\"waiting\"},{\"type\":\"txinsert\",\"transaction\":\"02a4c59fa7a4135dbcd6d3a664b4ad403e5cc91c12eece57ff9b124a95031ff7\",\"id\":\"29\",\"wallet_id\":\"1000001010000000444\",\"referance\":444,\"currency\":\"BTC\",\"amount\":\"0.30000000\",\"confirmation\":\"0\",\"status\":\"waiting\"}]",
      "status": "waiting"
    },
    {
      "id": "3",
      "time": "1542300661",
      "notification": "[{\"type\":\"txupdate\",\"transaction\":\"02a4c59fa7a4135dbcd6d3a664b4ad403e5cc91c12eece57ff9b124a95031ff7\",\"id\":\"28\",\"wallet_id\":\"1000001010000000001\",\"referance\":\"1\",\"currency\":\"BTC\",\"amount\":\"0.22000000\",\"confirmation\":\"1\",\"status\":\"waiting\"},{\"type\":\"txupdate\",\"transaction\":\"02a4c59fa7a4135dbcd6d3a664b4ad403e5cc91c12eece57ff9b124a95031ff7\",\"id\":\"29\",\"wallet_id\":\"1000001010000000444\",\"referance\":\"444\",\"currency\":\"BTC\",\"amount\":\"0.30000000\",\"confirmation\":\"1\",\"status\":\"waiting\"}]",
      "status": "waiting"
    }
  ]
}

4) Get wallets

To get all your wallets.

URL	https://api.coingateway.io
POST	https://api.coingateway.io/service/wallet/get
token
currency
wallet_id
referance
type
max_id
min_id
limit
	Make Request

Sample Request

curl -X POST "https://api.coingateway.io/service/wallet/get" \
     --data 'token={access_token}&currency=BTC&wallet_id=1000001010000000003'

Sample Result

{
  "result": "ok",
  "data": [
    {
      "wallet_id": "1000001010000000003",
      "referance": "3",
      "currency": "BTC",
      "type": "rental",
      "expire": "1542213375",
      "address": "mm4pDztsSZMLA4ozDasqUtr3M2cdFhZaNT"
    },
    {
      "wallet_id": "1000001040000000001",
      "referance": "1",
      "currency": "LTC",
      "type": "owned",
      "expire": "1544718346",
      "address": "mt8on4a6fAmWiSAM2buhSuPY7k969hguRi"
    },
    {
      "wallet_id": "1000001050000000001",
      "referance": "1",
      "currency": "DASH",
      "type": "owned",
      "expire": "1544719312",
      "address": "ybivnSmUDgWeC2f9XgNvUF2CqP8Ru8haMn"
    }
  ]
}

5) Rent new wallet

To rent a new wallet.

URL	https://api.coingateway.io
POST	https://api.coingateway.io/service/wallet/rent
token
currency
referance
expire
	Make Request

Sample Request

curl -X POST "https://api.coingateway.io/service/wallet/rent" \
     --data 'token={access_token}&currency=BTC,LTC&referance=27&expire=15'

Sample Result

{
  "result": "ok",
  "data": [
    {
      "wallet_id": "1000001010000000027",
      "referance": "27",
      "currency": "BTC",
      "type": "rental",
      "expire": "1542293359",
      "address": "mjnzSNNBDBUocbncDmtGgHXupMfqESXCK5"
    },
    {
      "wallet_id": "1000001040000000027",
      "referance": "27",
      "currency": "LTC",
      "type": "rental",
      "expire": "1542293359",
      "address": "mvcGZnggJrc3pxvdA7zUBBbcFgLR2LnWrR"
    }
  ]
}

6) Create new wallets

To create a wallet.

URL	https://api.coingateway.io
POST	https://api.coingateway.io/service/wallet/create
token
currency
referance
	Make Request

Sample Request

curl -X POST "https://api.coingateway.io/service/wallet/create" \
     --data 'token={access_token}&currency=BTC,DASH&referance=64'

Sample Result

{
  "result": "ok",
  "data": [
    {
      "wallet_id": "1000001010000000064",
      "referance": "64",
      "currency": "BTC",
      "type": "owned",
      "expire": "1544884504",
      "address": "n2F68PstyQ3HidPEBQWeUP7BXJBa8fEE99"
    },
    {
      "wallet_id": "1000001050000000064",
      "referance": "64",
      "currency": "DASH",
      "type": "owned",
      "expire": "1544884504",
      "address": "yQdA24Su5JfAehYC5iuKzNoCqxNyjeLctN"
    }
  ]
}

7) Delete an existing wallet

To delete a wallet which owns by you.

URL	https://api.coingateway.io
POST	https://api.coingateway.io/service/wallet/delete
token
wallet_id
currency
referance
	Make Request

Sample Request

curl -X POST "https://api.coingateway.io/service/wallet/delete" \
     --data 'token={access_token}&wallet_id=1000001010000000064'

Sample Result

{
  "result": "ok"
}

8) Payments list

To get outgoing payments which you made.

URL	https://api.coingateway.io
POST	https://api.coingateway.io/service/transaction/payments
token
payment_id
currency
max_id
min_id
limit
	Make Request

Sample Request

curl -X POST "https://api.coingateway.io/service/transaction/payments" \
     --data 'token={access_token}&payment_id=1'

Sample Result

{
  "result": "ok",
  "data": [
    {
      "id": "26",
      "currency": "DASH",
      "amount": "5.00000000",
      "commission": "0.00100000",
      "time": "1542289965",
      "pool": "false",
      "address": "yZCrndyF3qMzLaojP3mg1pZKRzRhEgPqGA",
      "transaction": "bd357c7301b5e307f3f4ea49eb4f2d757484c9a2e826bff404d71d2f772c300f",
      "sent": 1542289965,
      "status": "completed"
    },
    {
      "id": "25",
      "currency": "LTC",
      "amount": "0.80000000",
      "commission": "0.00050000",
      "time": "1542289480",
      "pool": "true",
      "address": "mt8on4a6fAmWiSAM2buhSuPY7k969hguRi",
      "transaction": "c004ba9933fdb93da9ad48679623e2ea7beae1fdb1f4690c3c0de790a5472bc8",
      "sent": 1542291234,
      "status": "completed"
    }
  ]
}

9) Make a payment

To make an outgoing payment.

URL	https://api.coingateway.io
POST	https://api.coingateway.io/service/transaction/pay
token
currency
amount
address
tag
pool
	Make Request

Sample Request

curl -X POST "https://api.coingateway.io/service/transaction/pay" \
     --data 'token={access_token}&currency=BTC&address=myLUuYE9oUrJtZowpe4GKEbVSQY2NsJh6S&amount=0.025&pool=false'

Sample Result

{
  "result": "ok",
  "data": {
    "id": 27,
    "currency": "BTC",
    "amount": "0.01000000",
    "commission": "0.00100000",
    "time": 1542293588,
    "address": "mjnzSNNBDBUocbncDmtGgHXupMfqESXCK5",
    "pool": "false",
    "transaction": "1031450e383502ebb2f8a3881c89b1c6ad059f383239af122e5d09ba071dd757",
    "sent": 1542293588,
    "status": "completed"
  }  
}

10) Cancel a payment

To cancel an outgoing payment.

URL	https://api.coingateway.io
POST	https://api.coingateway.io/service/transaction/cancel
token
payment_id
	Make Request

Sample Request

curl -X POST "https://api.coingateway.io/service/transaction/cancel" \
     --data 'token={access_token}&payment_id=1'

Sample Result

{
  "result": "ok"
}

11) Supported Coins

To get all supported crypto currencies.

URL	https://api.coingateway.io
POST	https://api.coingateway.io/service/data/coins
token
	Make Request

Sample Request

curl -X POST "https://api.coingateway.io/service/data/coins" \
     --data 'token={access_token}&currency=BTC'

Sample Result

{
  "result": "ok",
  "data": [
    {
      "currency": "BTC",
      "name": "Bitcoin",
      "tags": false,
      "pool": true
    },
    {
      "currency": "BCH",
      "name": "Bitcoin Cash",
      "tags": false,
      "pool": true
    },
    {
      "currency": "BTG",
      "name": "Bitcoin Gold",
      "tags": false,
      "pool": true
    },
    {
      "currency": "LTC",
      "name": "Litecoin",
      "tags": false,
      "pool": true
    },
    {
      "currency": "DASH",
      "name": "Dash",
      "tags": false,
      "pool": true
    }
  ]
}

12) Check wallet address validity

To check validity of a wallet address.

URL	https://api.coingateway.io
POST	https://api.coingateway.io/service/wallet/check
token
currency
address
	Make Request

Sample Request

curl -X POST "https://api.coingateway.io/service/wallet/check" \
     --data 'token={access_token}&currency=BTC&address=mjnzSNNBDBUocbncDmtGgHXupMfqESXCK5'

Sample Result

{
  "result": "ok",
  "data": [
    {
      "valid": true
    }
  ]
}

** Api Notes

If you have any question, please feel free to contact with us via tickets.

** Error Codes

Please contact with us to get informations about error codes.