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.

Documentation

Update

URL STRUCTURE

PUT https://gateway.gear.mycelium.com/api/gateways/:id

PARAMETERS (* Required field)

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

RETURNS

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

Example Request

REQUEST PUT https://gateway.gear.mycelium.com/api/gateways/5
PARAMETERS
{
  "name": "Another Gateway",
  "city": "Nadym",
  "convert_currency_to": 16,
  "default_currency": "EUR",
  "test_mode": true,
  "test_pubkey": "tpubDBdtUgft1TY5rVpxE4A37hF7EasC1YQU4YgZEs99q5ckSjh6DUeeZWCWcbLe1GaVjJhDtcLavnrVX5vRQsEtF3ZFxGgs6i8t8pQbCqzC821"
}
RETURNS
{
  "id": 5,
  "name": "Another Gateway",
  "confirmations_required": 0,
  "orders_expiration_period": 900,
  "default_currency": "EUR",
  "pubkey": "xpub661MyMwAqRbcEaJ7A42ZsAeGmpPbJ7GoRsWc8k4U27ywFtyzNWrG9J93K1CH9N6GkF2PkuTwg3XZvb4T5nBDSvwGRrbarhX7sjiNdLPsec3",
  "active": true,
  "address_derivation_scheme": "m/0/n",
  "callback_url": "http://0.0.0.0/my_store_callback",
  "after_payment_redirect_to": "http://0.0.0.0/after_payment",
  "auto_redirect": false,
  "city": "Nadym",
  "test_pubkey": "tpubDBdtUgft1TY5rVpxE4A37hF7EasC1YQU4YgZEs99q5ckSjh6DUeeZWCWcbLe1GaVjJhDtcLavnrVX5vRQsEtF3ZFxGgs6i8t8pQbCqzC821",
  "test_mode": true,
  "convert_currency_to": 16,
  "country": "Somalia",
  "exchange_rate_adapter_names": [
    "Bitpay",
    "Coinbase",
    "Bitstamp",
    "Bitpay"
  ],
  "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": "7429b19ee4700810101f9b199fe7511f68a4f1ef1a7cd43fe66ed8ea8d91d453",
  "back_url": null,
  "custom_css_url": null
}