Ajax loader
closes in 10 sec
You've just discovered an error in our application, we've been notified and will take care of it.




GET https://gateway.gear.mycelium.com/api/gateways


gateways (Array) Root element is array of hashes
gateways/id (Integer) ID of Gateway
gateways/name (String) Gateway name (will appear on payment page)
gateways/pubkey (String) BIP32 public key
gateways/confirmations_required (Integer) Bitcoin network confirmations required (0-6)
gateways/orders_expiration_period (Integer) Time (in seconds) which is given customer to make payment
gateways/default_currency (String) Currency code (ISO 4217) in which prices are shown to customer
gateways/active (Boolean) Whether a gateway can process new orders
gateways/test_mode (Boolean) Whether to use testnet for payment processing
gateways/test_pubkey (String) BIP32 testnet pulic key (used when test_mode is true)
gateways/address_derivation_scheme (String) Address derivation scheme: m/0/n or n
gateways/callback_url (String) URL to send server POST notifications of order statuses
gateways/auto_redirect (Boolean) Whether to enable redirection on successful payment
gateways/after_payment_redirect_to (String) URL to which redirect customers after successful payment (if auto_redirect is true)
gateways/back_url (String) URL to which redirect customers on order cancellation
gateways/convert_currency_to (Integer) ID of Address Provider which is to process payments, otherwise string 'BTC'
gateways/exchange_rate_adapter_names (Array) Array of String names of exchange rate adapters. Default: ["Bitstamp", "Btce", "Kraken"]
gateways/receive_payments_notifications (Boolean) Whether to send email notifications of payments
gateways/allow_links (Boolean) Allow links and <a> tags in field values
gateways/api_gateway_id (Integer) Straight server gateway ID
gateways/custom_css_url (String) URL to CSS file with a payment UI customizations
gateways/description (Integer) Description of merchant
gateways/merchant_url (Integer) URL of merchant site
gateways/country (String) Country of merchant
gateways/city (String) City of merchant
gateways/region (Integer) Region of merchant

Example Request

REQUEST GET https://gateway.gear.mycelium.com/api/gateways
    "id": 1,
    "name": "Custom Gateway",
    "confirmations_required": 0,
    "orders_expiration_period": 900,
    "default_currency": "BTC",
    "pubkey": "xpub661MyMwAqRbcGAEjBnRud6skEYkgn6HakP9in7r4YVRbe8FfZdwqQdteE4nZX4Dq9bQRQ25KCDiC8qSSkuEc5ecxHbWgNkzvKHqfim99CV5",
    "active": true,
    "address_derivation_scheme": "m/0/n",
    "callback_url": "",
    "after_payment_redirect_to": "",
    "auto_redirect": false,
    "city": "Mogadishu",
    "test_pubkey": null,
    "test_mode": false,
    "convert_currency_to": "BTC",
    "country": "Somalia",
    "exchange_rate_adapter_names": [
    "description": "Yet another gateway",
    "merchant_url": "http://mystore.com",
    "receive_payments_notifications": false,
    "region": "Central Somalia",
    "locale": null,
    "allow_links": false,
    "secret": null,
    "api_gateway_id": "6b7cf3dcddbb7abfb6e239e607809d131c159102f4961591a1aa18b2a868b61b",
    "back_url": null,
    "custom_css_url": null