📄Charge API

Create Charge

All charges have a variable minimum deposit amount. Any deposits below the minimum threshold will be ignored.

POST https://coinstack.net/api/v1/charge

Headers

Name	Type	Description
X-API-KEY*	String	Account API key

Request Body

Name	Type	Description
currency*	String	Charge currency
webhook*	String	Deposit webhook notification URL
metadata	String	Identifying metadata

200: OK

{
    "success":true,
    "response":{
        "charge":{
            "chargeID":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
            "currency":"{currency}",
            "address":"{address}[:{memo}]",
            "minimum":"{minimum}",
            "paid":false,
            "expired":false,
            "expires":86400,
            "webhook":"{webhook}",
            "metadata":"{metadata}"
        }
    }
}

Get Charge

GET https://coinstack.net/api/v1/charge

Headers

Name	Type	Description
X-API-KEY*	String	Account API key

Request Body

Name	Type	Description
chargeID*	String	Charge ID

200: OK

{
   "success":true,
   "response":{
      "charge":{
         "chargeID":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
         "currency":"{currency}",
         "address":"{address}[:{memo}]",
         "minimum":"{minimum}",
         "paid":true/false,
         "expired":true/false,
         "expires":{time till expiry in seconds}
         "webhook":"{webhook}",
         "metadata":"{metadata}"
      }
   }
}

Update Charge Webhook

PUT https://coinstack.net/api/v1/charge/webhook

Headers

Name	Type	Description
X-API-KEY*	String	Account API key

Request Body

Name	Type	Description
webhook*	String	Deposit webhook notification URL
chargeID*	String	Charge ID

200: OK

{
   "success":true,
   "response":{
      "charge":{
         "chargeID":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
         "webhook":"{webhook}"
      }
   }
}

Update Charge Metadata

PUT https://coinstack.net/api/v1/charge/metadata

Headers

Name	Type	Description
X-API-KEY*	String	Account API key

Request Body

Name	Type	Description
chargeID*	String	Charge ID
metadata*	String	Identifying metadata

200: OK

{
   "success":true,
   "response":{
      "charge":{
         "chargeID":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
         "metadata":"{metadata}"
      }
   }
}

Get Charge Currencies

GET https://coinstack.net/api/v1/charge/currencies

Headers

Name	Type	Description
X-API-KEY*	String	Account API key

200: OK

{
   "success":true,
   "response":{
      "currencies":[
         "BTC",
         "BTC-BEP20",
         "BTC-BEP2",
         "ETH",
         "ETH-BEP20",
         "ETH-BEP2",
         "LTC",
         "BCH",
         "BNB-BEP20",
         "BNB-BEP2",
         "SOL",
         "MATIC",
         "XMR",
         "XRP",
         "TRX",
         "DOGE",
         "ETC",
         "DASH",
         "ZEC",
         "XTZ",
         "USDT-TRC20",
         "USDT-BEP20",
         "USDT-SOL",
         "USDT-MATIC",
         "USDC-TRC20",
         "USDC-BEP20",
         "USDC-SOL",
         "USDC-MATIC",
         "BUSD-BEP20",
         "BUSD-BEP2",
         "DAI-BEP20"
      ]
   }
}