Balance

1. Create your website and get the “SECRET_KEY”. Instruction can be found here.

2. Send the “GET” request to see the cryptocurrency balance.

Endpoint:

https://payenium.com/api/v1/balances/<psys_cid>

cURL request example:

curl --location --request GET https://payenium.com/api/v1/balances/BTC
  ?api_key=SECRET_KEY

List of all supported request fields:

FieldDescription
api_key“Secret key” value from your API » Api settings page
psys_cidID column from one of the supported cryptocurrencies supported by Payenium

* – required

Success response example:

 {
    "status": "success",
    "data": {
      "currency": "BTC",
      "balance": "0.00110995"
    }
  }

HTTP response status code: 200

Error response example:

 {
    "status": "error",
    "data": {
      "name": "Unprocessable entity",
      "message": "Unsupported currency attribute value: {\"currency\":\"BTCX\"}",
      "code": 105
    }
  }

HTTP response status codes: 422, 500

Error response:

FieldDescription
statuserror
data.nameerror name
data.messageerror explanation
data.codeerror code