Hex Pay Docs
API Reference

List payment methods

Retrieves the payment methods enabled for your store. Each entry represents a unique coin + chain combination that your store accepts. Use it, for example, to show available payment options on your website.

Only your store's enabled methods are returned, not every coin supported by HexPay.

Use coin.symbol and chain.symbol values from this response as inputs for the coin and chain fields in paymentOptions.methods when creating a payment.

GET
/v1/payment-methods
AuthorizationBearer <token>

JWT token signed with the EdDSA algorithm. Obtain the token from the HexPay merchant dashboard and pass it via the Authorization: Bearer <token> header.

In: header

Response Body

curl -X GET "https://api.hexpay.io/v1/payment-methods"

{
  "data": [
    {
      "id": "0197ef69-6825-7bb4-8cd8-770ab407e240",
      "coin": {
        "name": "Toncoin",
        "symbol": "TON",
        "imgUrl": "https://assets.hexpay.io/coins/ton.svg"
      },
      "chain": {
        "name": "TON",
        "symbol": "TON",
        "imgUrl": "https://assets.hexpay.io/chains/ton.svg"
      }
    },
    {
      "id": "0197ef69-8297-72d3-94fb-50472539a1c8",
      "coin": {
        "name": "Tether",
        "symbol": "USDT",
        "imgUrl": "https://assets.hexpay.io/coins/usdt.svg"
      },
      "chain": {
        "name": "TON",
        "symbol": "TON",
        "imgUrl": "https://assets.hexpay.io/chains/ton.svg"
      }
    },
    {
      "id": "0197ef69-98b6-72d4-81a6-6b884fb674c2",
      "coin": {
        "name": "Notcoin",
        "symbol": "NOT",
        "imgUrl": "https://assets.hexpay.io/coins/not.svg"
      },
      "chain": {
        "name": "TON",
        "symbol": "TON",
        "imgUrl": "https://assets.hexpay.io/chains/ton.svg"
      }
    },
    {
      "id": "0197ef6a-3ffd-7ed1-8859-aeb815142b33",
      "coin": {
        "name": "Dogs",
        "symbol": "DOGS",
        "imgUrl": "https://assets.hexpay.io/coins/dogs.svg"
      },
      "chain": {
        "name": "TON",
        "symbol": "TON",
        "imgUrl": "https://assets.hexpay.io/chains/ton.svg"
      }
    },
    {
      "id": "0198b81f-4caf-72a3-a849-75b6c9bdad3e",
      "coin": {
        "name": "Blum",
        "symbol": "BLUM",
        "imgUrl": "https://assets.hexpay.io/coins/blum.svg"
      },
      "chain": {
        "name": "TON",
        "symbol": "TON",
        "imgUrl": "https://assets.hexpay.io/chains/ton.svg"
      }
    }
  ]
}

{
  "error": {
    "type": "authentication_error",
    "message": "Missing authorization token",
    "code": "auth_missing"
  }
}

{
  "error": {
    "type": "api_error",
    "message": "Internal server error",
    "code": "internal_error"
  }
}