Public
System status GET
Returns simple answer {"status":"OK"}.
Endpoint
GET https://switchere.com/api/v2/partner/healthcheck
Response
{
status: "OK"
}
| Name | Type | Description |
|---|---|---|
| status | string | System status. |
Available currencies GET
Return data about partner payin->payout currencies.
Endpoint
GET https://switchere.com/api/v2/public/currency
Response
{
"...": [
"...",
"...",
"..."
]
}
| Name | Type | Description |
|---|---|---|
| ... | dict of arrays | Payin currency -> [ Payout currencies for this Payin currency ]. |
Available payment methods GET
Return data about partner payments.
Endpoint
GET https://switchere.com/api/v2/public/payment/{directionName}
Parameters
| Name | Type | Description |
|---|---|---|
| directionName required | direction | Name of direction. |
Response
[
{
"group": "card",
"info": "USD, EUR",
"list": [
{
"currency": "USD",
"is_crypto": false
}
],
"title": "Credit/Debit Card"
}
]
| Name | Type | Description |
|---|---|---|
| group | paymentGroup | Payment group. |
| info | string | Info about group. |
| list | array | Array objects contain: currency and is_crypto. |
| title | string | Title for group. |
Tip: Field parameters info
Country list GET
Return data about all available countries on Switchere.
Endpoint
GET https://switchere.com/api/v2/public/country/list
Response
[
{
"code": "AF",
"forbidden": 0,
"forbidden_card": 0,
"name": "Afghanistan",
},
{
"code": "AL",
"forbidden": 0,
"forbidden_card": 0,
"name": "Albania",
},
...
]
| Name | Type | Description |
|---|---|---|
| code | country code | Country code. |
| forbidden | bool | If the value is set to 1, Switchere doesn't support this country. |
| forbidden_card | bool | If the value is set to 1, Switchere doesn't support the use of the bank card for this country. |
| name | string | Country name. |
Allowed countries by method GET
Return data about allowed countries for payout method.
Endpoint
GET https://switchere.com/api/v2/public/country/{methodName}/{directionName}
Parameters
| Name | Type | Description |
|---|---|---|
| methodName required | string | Example: ecommpay Name of payout method. |
| directionName required | direction | Name of direction. |
Response
[
"AD",
"AE",
"AF",
"..."
]
| Name | Type | Description |
|---|---|---|
| ... | array | Array of countries. |
Tip: Field parameters info
Ticker list GET
Return data about partner rates.
Endpoint
GET https://switchere.com/api/v2/public/ticker
Response
[
{
"ask": "21187.44",
"bid": "20364.70",
"floating_rate": "20752.5",
"name": "BTC-USD"
}
]
| Name | Type | Description |
|---|---|---|
| name | string | Pair name. |
| ask | float | Ask rate. |
| bid | float | Bid rate. |
| floating_rate | float | Floating rate. |
Ticker GET
Return data about partner rate.
Endpoint
GET https://switchere.com/api/v2/public/ticker/{tickerName}
Parameters
| Name | Type | Description |
|---|---|---|
| tickerName required | string | Example: BTC-USD Name of rate. |
Response
{
"ask": "21187.44",
"bid": "20364.70",
"floating_rate": "20752.5",
"name": "BTC-USD"
}
| Name | Type | Description |
|---|---|---|
| name | string | Pair name. |
| ask | float | Ask rate. |
| bid | float | Bid rate. |
| floating_rate | float | Floating rate. |
Order fee POST
Return data about fee for order.
Endpoint
POST https://switchere.com/api/v2/public/order/fee
Parameters
| Name | Type | Description |
|---|---|---|
| partner_order_id required | string | unique partner order id |
| payin_currency required | currency | payin currency |
| payin_amount | float | payin amount. One of payin_amount, payout_amount is required. |
| payin_group | paymentGroup | if empty, will be choosen first available method for payin currency. See order in enum. |
| payout_currency required | currency | payout currency |
| payout_amount | float | payout amount. One of payin_amount, payout_amount is required. |
| payout_group | paymentGroup | if empty, will be choosen first available method for payout currency. See order in enum. |
| is_floating_rate | integer[0..1] | Calculate order fee with or without floating rate. By default is_floating_rate = 0. |
Response
{
"payin_amount": "string",
"payout_amount": "string",
"rate": "string",
"payin_fee": "string",
"payout_fee": "string",
"margin_fee": "string"
}
| Name | Type | Description |
|---|---|---|
| payin_amount | string | payin currency |
| payout_amount | string | payout amount |
| rate | string | rate payin_currency/payout_currency |
| payin_fee | string | network fee in payin currency |
| payout_fee | string | network fee in payout currency |
| margin_fee | string | service fee in payin currency |
Tip: Field parameters info
TIP
Also see field parameters