Partner API

System status GET

Returns simple answer {"status":"OK"}.

Endpoint

GET https://switchere.com/api/v1/partner/healthcheck

Authentication

headerKey and headerSignature

Response

{
    status: "OK"
}
NameTypeDescription
statusstringSystem status

Order list GET

Returns simple answer {"status":"OK"}.

Endpoint

GET https://switchere.com/api/v1/partner/order/list

Authentication

headerKey and headerSignature

Parameters

NameTypeDescription
pageintegerpage number
rowsintegerhow many rows return on one page
timestampunix_timestamp_stringselect orders created only from a ceratin timestamp

Response

{
    "rows": 50, 
    "total": 110,
    "data": {
        "created_at": "1621409585.000000",
        "id": 123,
        "partner_order_id": "xxxxx-xxxxx-xxxxx-xxxx1",
    }
    ...
}
NameTypeDescription
rowsintegerSystem status
totaltintegerSystem status
dataarrayArray of order data. Each element of the array has fields: created_at, id, partner_order_id

TIP

  • created_at - timestamp
  • id - internal order id
  • partner_order_id - external order id

Order data POST

Return order data.

Endpoint

POST https://switchere.com/api/v1/partner/order

Authentication

headerKey and headerSignature

Parameters

NameTypeDescription
partner_order_id requiredstringunique partner order id

Response

{
    "partner_order_id": "xxxxx-xxxxx-xxxxx-xxxx1",
    "payin_amount": 100.01,
    "payout_amount": 100.01,
    "payin_currency": "USD",
    "payout_currency": "BTC",
    "payout_txid": "944a88f6331c057f53e0a4d16232a44401ae14874a3d8a6fd30030781e7340ea",
    "status": "finished",
    "dst_address": "3M97Nfbrnf2yYxYJKJ9S8eZoxRKiq6Frju",
    "dst_tag": 0,
    "memo_id": "somestring",
    "memo_value": "SomeString"
}
NameTypeDescription
partner_order_idstringunique partner order id
payin_amountfloatpayin currency
payout_amountfloatpayout amount
payin_currencycurrencypayin currency
payout_currencycurrencypayout currency
payout_txidstringtxid of payout transaction
statusorderStatuscurrent status of order
dst_addressstringwallet address where Switchere will send cryptocurrency
dst_taginteger[0..4294967295]tag for XRP address.
memo_idstringmemo_id for EOS address.
memo_valuestringmemo_value for XLM address

Tip: Field parameters info

Order fee POST

Return data about fee for order.

Endpoint

POST https://switchere.com/api/v1/partner/order/fee

Authentication

headerKey and headerSignature

Parameters

NameTypeDescription
partner_order_id requiredstringunique partner order id
payin_currency requiredcurrencypayin currency
payin_amountfloatpayin amount. One of payin_amount, payout_amount is required.
payin_grouppaymentGroupif empty, will be choosen first available method for payin currency. See order in enum.
payout_currency requiredcurrencypayout currency
payout_amountfloatpayout amount. One of payin_amount, payout_amount is required.
payout_grouppaymentGroupif empty, will be choosen first available method for payout currency. See order in enum.
free_firstinteger[0..1]enable or disable free first order policy. By default free_first = 1

Response

{
    "payin_amount": "string",
    "payout_amount": "string",
    "payin_min_amount": "string",
    "payin_max_amount": "string",
    "payout_min_amount": "string",
    "payout_max_amount": "string",
    "rate": "string",
    "payin_fee": "string",
    "payout_fee": "string",
    "margin_fee": "string",
}
NameTypeDescription
payin_amountstringpayin amount
payout_amountstringpayout amount
payin_min_amountstringpayin min amount
payin_max_amountstringpayin max amount
payout_max_amountstringpayout min amount
payout_amountstringpayout max amount
ratestringrate payin_currency/payout_currency
payin_feestringnetwork fee in payin currency
payout_feestringnetwork fee in payout currency
margin_feestringservice fee in payin currency

Tip: Field parameters info

Currencies GET

Return data about partner payin->payout currencies.

Endpoint

GET https://switchere.com/api/v1/partner/currency

Authentication

headerKey and headerSignature

Response

{
    "...": [
        "...",
        "...",
        "..."
    ]   
}
NameTypeDescription
...arraypayout currencies

Payments GET

Return data about partner payments.

Endpoint

GET https://switchere.com/api/v1/partner/payment/{directionName}

Authentication

headerKey and headerSignature

Parameters

NameTypeDescription
directionName requireddirectionName of direction.

Response

[
    {
        "group": "card",
        "info": "USD, EUR",
        "list": [
            {
            "currency": "USD",
            "is_crypto": true
            }
        ],
        "title": "Credit/Debit Card"
    }
]
NameTypeDescription
grouppaymentGrouppayment group
infostringinfo for group
listarrayarray objects contain: currency and is_crypto
titlestringtitle for group

Tip: Field parameters info

Tickers GET

Return data about partner rates.

Endpoint

GET https://switchere.com/api/v1/partner/ticker

Authentication

headerKey and headerSignature

Response

[
    {
        "name": "BTC-USD",
        "ask": 100.01,
        "bid": 99.9
    }
]
NameTypeDescription
namestringpair name
askstringask
bidstringbid

Ticker GET

Return data about partner rate.

Endpoint

GET https://switchere.com/api/v1/partner/ticker/{tickerName}

Authentication

headerKey and headerSignature

Parameters

NameTypeDescription
tickerName requiredstringExample: BTC-USD
Name of rate.

Response

{
    "name": "BTC-USD",
    "ask": 100.01,
    "bid": 99.9
}
NameTypeDescription
namestringpair name
askstringask
bidstringbid

Callback POST

Callbacks to your system.

Endpoint

POST https://your.endpoint.com/callback

Authentication

headerCallbackSignature

Parameters

NameTypeDescription
partner_order_idstringunique partner order id
payin_amountfloatpayin currency
payout_amountfloatpayout amount
payin_currencycurrencypayin currency
payout_currencycurrencypayout currency
statusorderStatuscurrent status of order
dst_addressstringwallet address where Switchere will send cryptocurrency
dst_taginteger[0..4294967295]tag for XRP address.
memo_idstringmemo_id for EOS address.
memo_valuestringmemo_value for XLM address

Tip: Field parameters info

Response

Response is empty




TIP

Also see field parameters.

Last Updated: