B2Core API REST API The Back Office API Deposit methods

Deposit methods

Use these methods to obtain data about deposit methods and groups configured in the Back Office, as well as currencies enabled for these methods and commissions that are charged when clients deposit funds to their accounts.

GET[host]/api/v2/deposits/groups	Get a list of deposit groups
GET[host]/api/v2/deposits/groups/{groupId}	Get deposit group details
POST[host]/api/v2/deposits/groups	Create a deposit group
PUT[host]/api/v2/deposits/groups/{groupId} PATCH[host]/api/v2/deposits/groups/{groupId}	Update a deposit group
DELETE[host]/api/v2/deposits/groups/{groupId}	Delete a deposit group

GET[host]/api/v2/deposits/methods	Get a list of deposit methods
GET[host]/api/v2/deposits/methods/{methodId}	Get deposit method details
POST[host]/api/v2/deposits/methods	Create a deposit method
PUT[host]/api/v2/deposits/methods/{methodId} PATCH[host]/api/v2/deposits/methods/{methodId}	Update a deposit method
DELETE[host]/api/v2/deposits/methods/{methodId}	Delete a deposit method

GET[host]/api/v2/deposits/methods/{methodId}/commissions	Get a list of deposit commissions
GET[host]/api/v2/depositls/methods/{methodId}/commissions/{commissionId}	Get Deposit commission details
POST[host]/api/v2/deposits/methods/{methodId}/commissions	Add a deposit commission
PUT[host]/api/v2/deposits/methods/{methodId}/commissions/{commissionId} PATCH[host]/api/v2/deposits/methods/{methodId}/commissions/{commissionId}	Update a deposit commission
DELETE[host]/api/v2/deposits/methods/{methodId}/commissions/{commissionId}	Delete a deposit commission

GET[host]/api/v2/deposits/methods/{methodId}/currencies	Get a list of deposit currencies
GET[host]/api/v2/deposits/methods/{methodId}/currencies/{currencyId}	Get Deposit currency details
POST[host]/api/v2/deposits/methods/{methodId}/currencies	Add a deposit currency
PUT[host]/api/v2/deposits/methods/{methodId}/currencies/{currencyId} PATCH[host]/api/v2/deposits/methods/{methodId}/currencies/{currencyId}	Update a deposit currency
DELETE[host]/api/v2/deposits/methods/{methodId}/currencies/{currencyId}	Delete a deposit currency

Use the following methods to manage the attributes added to the Constructor deposit method.

GET[host]/api/v2/deposits/methods/{methodId}/attributes	Get a list of deposit method attributes
GET[host]/api/v2/deposits/methods/{methodId}/attributes/{attributeId}	Get deposit method attribute details
POST[host]/api/v2/deposits/methods/{methodId}/attributes	Add a deposit method attribute
DELETE[host]/api/v2/deposits/methods/{methodId}/attributes/{attributeId}	Delete a deposit method attribute

GET[host]/api/v2/deposits/{methodId}/restrictions	Get a list of deposit method restrictions
GET[host]/api/v2/deposits/{methodId}/restrictions/{restrictionId}	Get deposit method restriction details
POST[host]/api/v2/deposits/{methodId}/restrictions	Add a new deposit method restriction
PUT[host]/api/v2/deposits/{methodId}/restrictions/{restrictionId} PATCH[host]/api/v2/deposits/{methodId}/restrictions/{restrictionId}	Update a deposit method restriction
DELETE[host]/api/v2/deposits/{methodId}/restrictions/{restrictionId}	Delete a deposit method restriction

Get a list of deposit groups

Use this method to obtain a list of deposit groups configured in the Back Office.

Request

Header parameters:

Authorization: Bearer <token>

Query parameters: The following filter parameters are available for this method:

isEnabled: If true, a group is enabled; otherwise, false.
name: The deposit group name used in the Back Office.
caption: The deposit group name displayed to clients in the B2Core UI.

The following sorting parameter is available for this method:

createTime: The date and time when a deposit group was configured.

Refer to the Query parameters section in the API Overview for details on applying filter and sorting parameters.

GET[host]/api/v2/deposits/groups

curl --location -g 'https://host.name/api/v2/deposits/groups?limit=10&offset=0&sort_order=desc&filter[isEnabled]=1&filter[name]=crypto&filter[caption]=crypto&sort_by=createTime' \
--header 'Authorization: Bearer <token>' \
--header 'accept-language: ja'

Response

A response contains an array of Deposit Group objects providing information about the deposit groups matching the request parameters.

Get deposit group details

Use this method to obtain detailed information about a specified deposit group.

Request

Header parameters:

Authorization: Bearer <token>

Path parameters:

groupId required: The identifier of a deposit group.

GET[host]/api/v2/deposits/groups/{groupId}

curl --location 'https://host.name/api/v2/deposits/groups/1' \
--header 'Authorization: Bearer <token>' \
--header 'accept-language: ja'

Response

A response contains a Deposit Group object providing information about the specified deposit group.

Create a deposit group

Use this method to create a deposit group.

Request

Header parameters:

Authorization: Bearer <token>

Body:

Specify the following parameters for a new deposit group:

name string: The deposit group name used in the Back Office.
caption string: The deposit group name displayed to clients in the B2Core UI.
isEnabled boolean: If true, a group is enabled; otherwise, false.
icon string: The filename of an image that is displayed as a deposit group icon.
description string: The deposit group description.

POST[host]/api/v2/deposits/groups

curl --location 'https://host.name/api/v2/deposits/groups' \
--header 'Authorization: Bearer <token>' \
--header 'accept-language: ja' \
--data '{
  "name": "crypto",
  "caption": "crypto",
  "isEnabled": false,
  "icon": "image.png",
  "description": "Group description"
}'

Response

A response contains a Deposit Group object providing information about the created deposit group.

Update a deposit group

Use this method to update a specified deposit group.

Note

Instead of the method described below, you can use a similar method that uses the HTTP verb PATCH.

Request

Header parameters:

Authorization: Bearer <token>

Path parameters:

groupId required: The identifier of a deposit group.

Body:

The following field values can be updated for a specified deposit group:

name string: The deposit group name used in the Back Office.
caption string: The deposit group name displayed to clients in the B2Core UI.
isEnabled boolean: If true, a group is enabled; otherwise, false.
icon string: The filename of an image that is displayed as a deposit group icon.
description string: The deposit group description.
priority integer: The priority index assigned to a deposit group.

PUT[host]/api/v2/deposits/groups/{groupId}

curl --location --request PATCH 'https://host.name/api/v2/deposits/groups/1' \
--header 'Authorization: Bearer <token>' \
--header 'accept-language: ja' \
--data '{
  "name": "crypto",
  "caption": "crypto",
  "isEnabled": false,
  "icon": "image.png",
  "description": "Group description",
  "priority": 1
}'

Response

A response contains a Deposit Group object providing information about the deposit group that was updated.

Delete a deposit group

Use this method to delete a specified deposit group.

Request

Header parameters:

Authorization: Bearer <token>

Path parameters:

groupId required: The identifier of a deposit group.

DELETE[host]/api/v2/deposits/groups/{groupId}

curl --location --request DELETE 'https://host.name/api/v2/deposits/groups/1' \
--header 'Authorization: Bearer <token>'

Response

In case of success, no response body is returned.

Get a list of deposit methods

Use this method to obtain a list of deposit methods configured in the Back Office.

Request

Header parameters:

Authorization: Bearer <token>

Query parameters:

The following filter parameters are available for this method:

isEnabled: If true, a method is enabled; otherwise, false.
name: The deposit method name used in the Back Office.
groupId: The identifier of a group in which a deposit method is included.
provider: The name of a payment system used to make deposits.
currencyNumericCode: The numeric code of a currency that is added to a deposit method.

The following sorting parameter is available for this method:

createTime: The date and time when a deposit method was configured.

Refer to the Query parameters section in the API Overview for details on applying filter and sorting parameters.

GET[host]/api/v2/deposits/methods

curl --location -g 'https://host.name/api/v2/deposits/methods?limit=10&offset=0&sort_order=desc&filter[isEnabled]=&filter[name]=B2BinPay&filter[groupId]=1&filter[provider]=B2BinPay&filter[currencyNumericCode]=840&sort_by=createTime' \
--header 'Authorization: Bearer <token>' \
--header 'accept-language: ja'

Response

A response contains an array of Deposit Method objects providing information about the deposit methods matching the request parameters.

Get deposit method details

Use this method to obtain detailed information about a specified deposit method.

Request

Header parameters:

Authorization: Bearer <token>

Path parameters:

methodId required: The identifier of a deposit method.

GET[host]/api/v2/deposits/methods/{methodId}

curl --location 'https://host.name/api/v2/deposits/methods/70466330' \
--header 'Authorization: Bearer <token>' \
--header 'accept-language: ja'

Response

A response contains a Deposit Method object providing information about the specified deposit method.

Create a deposit method

Use this method to create a deposit method.

Request

Header parameters:

Authorization: Bearer <token>

Body:

Specify the following parameters for a new deposit method:

name string: The deposit method name used in the Back Office.
provider string: The name of a payment system used to make deposits.
caption string: The deposit method name displayed to clients in the B2Core UI.
connectionId string: The identifier of an external connection configured for accessing a payment provider.
groupIds array: The identifier of a group in which a deposit method is included.
isEnabled boolean: If true, a method is enabled; otherwise, false.
timeToFundKey string: A hint displayed to clients in the B2Core UI about the period during which a deposit transaction is processed.
precalculate boolean: If true, the commission amount charged for depositing funds is calculated and displayed to a client in the B2Core UI; otherwise, false.
icon string: The filename of an image that is displayed as a deposit method icon.
priority integer: The priority index assigned to a deposit method.
ipWhiteList string: The list of allowed IP addresses.
ratesProvider string: The name of an exchange rate provider associated with a deposit method.
providerOptions object: The settings specific to a payment provider used to make deposits.
resources object: An array of resource objects, specifying localized strings for user interface pages displayed to a client.

POST[host]/api/v2/deposits/methods

curl --location 'https://host.name/api/v2/deposits/methods' \
--header 'Authorization: Bearer <token>' \
--header 'accept-language: ja' \
--data '{
  "name": "B2BinPay",
  "provider": "B2BinPay",
  "caption": "B2BinPay",
  "connectionId": 1,
  "groupIds": [
    1,
    2
  ],
  "isEnabled": false,
  "timeToFundKey": "Depending on the blockchain",
  "precalculate": true,
  "icon": "image.png",
  "priority": 1,
  "ipWhiteList": "IP White List",
  "ratesProvider": "B2BinPay2",
  "providerOptions": {},
  "resources": [
    {
      "key": "caption",
      "locale": "ru_RU",
      "value": "value"
    },
    {
      "key": "caption",
      "locale": "ja_JP",
      "value": "value"
    }
  ]
}'

Response

A response contains a Deposit Method object providing information about the created deposit method.

Update a deposit method

Use this method to update a specified deposit method.

Note

Instead of the method described below, you can use a similar method that uses the HTTP verb PATCH.

Request

Header parameters:

Authorization: Bearer <token>
Content-Type: application/json

Path parameters:

methodId required: The identifier of a deposit method.

Body:

The following field values can be updated for a deposit method:

name string: The deposit method name used in the Back Office.
caption string: The deposit method name displayed to clients in the B2Core UI.
groupId array: The identifier of a group in which a deposit method is included.
isEnabled boolean: If true, a method is enabled; otherwise, false.
timeToFundKey string: A hint displayed to clients in the B2Core UI about the period during which a deposit transaction is processed.
precalculate boolean: If true, the commission amount charged for depositing funds is calculated and displayed to a client in the B2Core UI; otherwise, false.
icon string: The filename of an image that is displayed as a deposit method icon.
priority integer: The priority index assigned to a deposit method.
ipWhiteList string: The list of allowed IP addresses.
ratesProvider string: The name of an exchange rate provider associated with a deposit method.
providerOptions object: The settings specific to a payment provider used to make deposits.
resources object: An array of resource objects, specifying localized strings for user interface pages displayed to a client.

PUT[host]/api/v2/deposits/methods/{methodId}

curl --location --request PATCH 'https://host.name/api/v2/deposits/methods/1' \
--header 'Authorization: Bearer <token>' \
--header 'accept-language: ja' \
--data '{
  "name": "B2BinPay",
  "caption": "B2BinPay",
  "groupIds": [
    1,
    2
  ],
  "isEnabled": false,
  "timeToFundKey": "Depending on the blockchain",
  "precalculate": false,
  "icon": "image.png",
  "priority": 1,
  "ipWhiteList": "IP White List",
  "ratesProvider": "B2BinPay2",
  "providerOptions": {},
  "resources": [
    {
      "key": "caption",
      "locale": "ru_RU",
      "value": "value"
    },
    {
      "key": "caption",
      "locale": "ja_JP",
      "value": "value"
    }
  ]
}'

Response

A response contains a Deposit Method object providing information about the deposit method that was updated.

Delete a deposit method

Use this method to delete a specified deposit method.

Request

Header parameters:

Authorization: Bearer <token>

Path parameters:

methodId required: The identifier of a deposit method.

DELETE[host]/api/v2/deposits/methods/{methodId}

curl --location --request DELETE 'https://host.name/api/v2/deposits/methods/1' \
--header 'Authorization: Bearer <token>'

Response

In case of success, no response body is returned.

Get a list of deposit commissions

Use this method to obtain a list of commissions configured for a specified deposit method.

Request

Header parameters:

Authorization: Bearer <access_token>

Path parameters

methodId required: The identifier of a deposit method.

Query parameters:

The following filter parameters are available for this method:

recipientType

Indicates whether a commission is charged by a broker or payment system. Possible values:

vendor — a commission is charged by a broker
provider — a commission is charged by a payment system

currencyNumericCode

The numeric code of a currency in which a commission is charged.

The following sorting parameter is available for this method:

createTime: The date and time when a deposit commission was configured.

Refer to the Query parameters section in the API Overview for details on applying filter and sorting parameters.

GET[host]/api/v2/deposits/methods/{methodId}/commissions

curl --location -g 'https://host.name/api/v2/deposits/methods/1/commissions?limit=10&offset=0&sort_order=desc&filter[recipientType]=vendor&filter[currencyNumericCode]=840&sort_by=createTime' \
--header 'Authorization: Bearer <token>' \
--header 'accept-language: ja'

Response

A response contains an array of Deposit Commission objects providing information about the commissions matching the request parameters.

Get Deposit commission details

Use this method to obtain detailed information about a specified commission configured for a deposit method.

Request

Path parameters:

methodId required: The identifier of a deposit method.
commissionId required: The commission identifier.

GET[host]/api/v2/deposits/methods/{methodId}/commissions/{commissionId}

curl --location 'https://host.name/api/v2/deposits/methods/70466330/commissions/70466330' \
--header 'Authorization: Bearer <token>' \
--header 'accept-language: ja'

Response

A response contains a Deposit Commission object providing information about a specified commission.

Add a deposit commission

Use this method to configure a new commission for a specified deposit method.

Request

Header parameters:

Authorization: Bearer <token>

Body:

Specify the following parameters when adding a deposit commission:

currencyNumericCode integer required

The numeric code of a currency in which a commission is charged.

type string required

The commission type.

recipientType string required

Indicates whether a commission is charged by a broker or payment system. Possible values:

vendor — a commission is charged by a broker
provider — a commission is charged by a payment system

percent string

The percentage of a deposit amount charged as a commission.

fix string

The fixed commission amount.

min string

The minimum commission amount.

max string

The maximum commission amount.

POST[host]/api/v2/deposits/methods/{methodId}/commissions

curl --location 'https://host.name/api/v2/deposits/methods/1/commissions' \
--header 'Authorization: Bearer <token>' \
--header 'accept-language: ja' \
--data '{
  "currencyNumericCode": 840,
  "type": "default",
  "recipientType": "vendor",
  "percent": "5.00",
  "fix": "10.00",
  "min": "15.00",
  "max": "20.00"
}'

Response

A response body includes a Deposit Commission object providing information about a commission configured for a deposit method.

Update a deposit commission

Use this method to update a specified commission configuration for a deposit method.

Note

Instead of the method described below, you can use a similar method that uses the HTTP verb PATCH.

Request

Header parameters:

Authorization: Bearer <access_token>

Path parameters:

methodId required: The identifier of a deposit method.
commissionId required: The commission identifier.

Body:

The following field values can be updated for a deposit method commission:

type string

The commission type.

recipientType string

Indicates whether a commission is charged by a broker or payment system. Possible values:

vendor — a commission is charged by a broker
provider — a commission is charged by a payment system

percent string

The percentage of a deposit amount charged as a commission.

fix string

The fixed amount of commission.

min string

The minimum commission amount.

max string

The maximum commission amount.

PUT[host]/api/v2/deposits/methods/{methodId}/commissions/{commissionId}

curl --location --request PATCH 'https://host.name/api/v2/deposits/methods/1/commissions/70466330' \
--header 'Authorization: Bearer <token>' \
--header 'accept-language: ja' \
--data '{
  "type": "default",
  "recipientType": "vendor",
  "percent": "5.00",
  "fix": "10.00",
  "min": "15.00",
  "max": "20.00"
}'

Response

A response includes a Deposit Commission object providing information about the commission that was updated.

Delete a deposit commission

Use this method to delete a commission that was previously configured for a deposit method.

Request

Header parameters:

Authorization: Bearer <access_token>

Path parameters:

methodId required: The identifier of a deposit method.
commissionId required: The commission identifier.

DELETE[host]/api/v2/deposits/methods/{methodId}/commissions/{commissionId}

curl --location --request DELETE 'https://host.name/api/v2/deposits/methods/1/commissions/1' \
--header 'Authorization: Bearer <token>'

Response

In case of success, no response body is returned.

Get a list of deposit currencies

Use this method to obtain a list of currencies added to a specified deposit method.

Request

Header parameters:

Authorization: Bearer <access_token>

Query parameters:

The following filter parameters are available for this method:

isEnabled

If true, a currency is enabled for a deposit method; otherwise false.

type

The type of a currency added to a deposit method. Possible values:

tradersRoom — transaction currencies
paymentSystem — payment currencies

currencyNumericCode

The numeric code of a currency (such as 1000).

The following sorting parameter is available for this method:

createTime: The date and time when a currency was added to a deposit method.

Refer to the Query parameters section in the API Overview for details on applying filter and sorting parameters.

Path parameters

methodId required: The identifier of a deposit method.

GET[host]/api/v2/deposits/methods/{methodId}/currencies

curl --location -g 'https://host.name/api/v2/deposits/methods/1/currencies?sort_order=desc&limit=10&offset=0&filter[isEnabled]=1&filter[type]=tradersRoom&filter[currencyNumericCode]=1000&sort_by=createTime' \
--header 'Authorization: Bearer <token>' \
--header 'accept-language: ja'

Response

A response contains an array of Deposit Currency objects providing information about the currencies matching the request parameters.

Get Deposit currency details

Use this method to obtain detailed information about a specified currency added to a deposit method.

Request

Path parameters:

methodId required: The identifier of a deposit method.
currencyId required: The identifier of a deposit currency.

GET[host]/api/v2/deposits/methods/{methodId}/currencies/{currencyId}

curl --location 'https://host.name/api/v2/deposits/methods/70466330/currencies/70466330' \
--header 'Authorization: Bearer <token>' \
--header 'accept-language: ja'

Response

A response contains a Deposit Currency object providing information about a specified currency added to a deposit method.

Add a deposit currency

Use this method to add a currency to a deposit method.

Request

Header parameters:

Authorization: Bearer <token>

Path parameters:

methodId required: The identifier of a deposit method.

Body:

Specify the following parameters when adding a currency:

type string required

The currency type. Possible values:

tradersRoom — a currency is added as a transaction currency
paymentSystem — a currency is added as a payment currency

currencyNumericCode integer required

The numeric code of a currency (such as 1000).

caption string

The currency name displayed to clients in the B2Core UI.

isEnabled boolean required

If true, a currency is enabled for a deposit method; otherwise, false.

icon string

The filename of an image that is displayed as a deposit currency icon.

min string

The minimum amount that can be deposited in a currency.

max string

The maximum amount that can be deposited in a currency.

blockExporter string

Applicable only for cryptocurrencies.

The cryptocurrency block explorer.

blockchainCode integer

Applicable only for cryptocurrencies.

The currency code in a blockchain.

blockchainAlpha string

Applicable only for cryptocurrencies.

The alphabetic code of a currency in a blockchain.

POST[host]/api/v2/deposits/methods/{methodId}/currencies

curl --location 'https://host.name/api/v2/deposits/methods/1/currencies' \
--header 'Authorization: Bearer <token>' \
--header 'accept-language: ja' \
--data '{
  "type": "tradersRoom",
  "currencyNumericCode": 1000,
  "caption": "Bitcoin",
  "isEnabled": true,
  "icon": "image.png",
  "min": "10.00",
  "max": "20.00",
  "blockExporter": "https://www.blockchain.com/btc/tx/{address}",
  "blockchainCode": 123,
  "blockchainAlpha": "BTC"
}'

Response

A response body includes a Deposit Currency object providing information about the added currency.

Update a deposit currency

Use this method to update a specified currency added to a deposit method.

Note

Instead of the method described below, you can use a similar method that uses the HTTP verb PATCH.

Request

Header parameters:

Authorization: Bearer <access_token>

Path parameters:

methodId required: The identifier of a deposit method.
currencyId required: The identifier of a depositl currency.

Body:

The following field values can be updated for a deposit currency:

caption string

The currency name displayed to clients in the B2Core UI.

isEnabled boolean

If true, a currency is enabled for a deposit method; otherwise, false.

icon string

The filename of an image that is displayed as a deposit currency icon.

min string

The minimum amount that can be deposited in a currency.

max string

The maximum amount that can be deposited in a currency.

blockExporter string

Applicable only for cryptocurrencies.

The cryptocurrency block explorer.

blockchainCode integer

Applicable only for cryptocurrencies.

The currency code in a blockchain.

blockchainAlpha string

Applicable only for cryptocurrencies.

The alphabetic code of a currency in a blockchain.

PUT[host]/api/v2/deposits/methods/{methodId}/currencies/{currencyId}

curl --location --request PATCH 'https://host.name/api/v2/deposits/methods/1/currencies/70466330' \
--header 'Authorization: Bearer <token>' \
--header 'accept-language: ja' \
--data '{
  "caption": "Bitcoin",
  "isEnabled": true,
  "icon": "image.png",
  "min": "10.00",
  "max": "20.00",
  "blockExporter": "https://www.blockchain.com/btc/tx/{address}",
  "blockchainCode": 123,
  "blockchainAlpha": "BTC"
}'

Response

A response includes a Deposit Currency object providing information about the currency that was updated.

Delete a deposit currency

Use this method to delete a currency that was previously added to a specified deposit method.

Request

Header parameters:

Authorization: Bearer <access_token>

Path parameters

methodId required: The identifier of a deposit method.
currencyId required: The identifier of a deposit currency that you want to delete.

DELETE[host]/api/v2/deposits/methods/{methodId}/currencies/{currencyId}

curl --location --request DELETE 'https://host.name/api/v2/deposits/methods/1/currencies/1' \
--header 'Authorization: Bearer <token>'

Response

In case of success, no response body is returned.

Get a list of deposit method attributes

Use this method to obtain a list of attributes added to a specified deposit method.

Request

Header parameters:

Authorization: Bearer <access_token>

Path parameters

methodId required: The identifier of a deposit method.

GET[host]/api/v2/deposits/methods/{methodId}/attributes

curl --location -g 'https://host.name/api/v2/deposits/methods/1/attributes' \
--header 'Authorization: Bearer <token>' \

Response

A response contains an array of Deposit Method Attribute objects providing information about the attributes matching the request parameters.

Get deposit method attribute details

Use this method to obtain detailed information about a specified attribute added to a deposit method.

Request

Path parameters:

methodId required: The identifier of a deposit method.
attributeId required: The identifier of a deposit method attribute.

GET[host]/api/v2/deposits/methods/{methodId}/attributes/{attributeId}

curl --location 'https://host.name/api/v2/deposits/methods/1/attributes/1' \
--header 'Authorization: Bearer <token>' \

Response

A response contains a Deposit Method Attribute object providing information about a specified attribute added to a deposit method.

Add a deposit method attribute

Use this method to add an attribute to a deposit method.

Request

Header parameters:

Authorization: Bearer <token>

Path parameters:

methodId required: The identifier of a deposit method.

Body:

Specify the following parameters when adding an attribute:

caption string required

The attribute name displayed to clients in the B2Core UI.

type string required

The attribute type. Possible values:

selectAutocomplete
input

POST[host]/api/v2/deposits/methods/{methodId}/attributes

curl --location 'https://host.name/api/v2/deposits/methods/1/attributes' \
--header 'Authorization: Bearer <token>' \
--data-raw '{
  "caption": "Code",
  "type": "selectAutocomplete"
}'

Response

A response body includes a Deposit Method Attribute object providing information about the added attribute.

Delete a deposit method attribute

Use this method to delete an attribute that was previously added to a specified deposit method.

Request

Header parameters:

Authorization: Bearer <access_token>

Path parameters

methodId required: The identifier of a deposit method.
attributeId required: The identifier of a deposit method attribute that you want to delete.

DELETE[host]/api/v2/deposits/methods/{methodId}/attributes/{attributeId}

curl --location --request DELETE 'https://host.name/api/v2/deposits/methods/1/attributes/1' \
--header 'Authorization: Bearer <token>'

Response

In case of success, no response body is returned.

Get a list of deposit method restrictions

Use this method to obtain a list of restrictions added for a specified deposit method.

Use a separate method to get deposit method restriction details.

Request

Header parameters:

Authorization: Bearer <token>

Path parameters:

methodId required: The deposit method identifier.

Query parameters:

The following filter parameter is available for this method:

name string

The deposit method restriction name. Possible values:

country — allows or forbids the use of a deposit method for specified countries.
client_type — allows or forbids the use of a deposit method for specified client types.
verification_level_restriction — allows or forbids the use of a deposit method for specified client verification levels.

Refer to the Query parameters section in the API Overview for details on applying filter and sorting parameters.

GET[host]/api/v2/deposits/methods/{methodId}/restrictions

curl --location --request GET 'https://host.name/api/v2/deposits/methods/1/restrictions/22' \
--header 'Authorization: Bearer <token>'

Response

A response includes an array of Deposit Method Restriction objects providing information about the deposit method restrictions matching the request parameters.

Get deposit method restriction details

Use this method to obtain detailed information about a specified deposit method restriction.

Use a separate method to get a list of deposit method restrictions.

Request

Header parameters:

Authorization: Bearer <access_token>

Path parameters:

methodId integer required: The deposit method identifier.
restrictionId integer required: The identifier of a deposit method restriction.

GET[host]/api/v2/deposits/methods/{methodId}/restrictions/{restrictionId}

curl --location --request GET 'https://host.name/api/v2/deposits/methods/1/restrictions' \
--header 'Authorization: Bearer <token>'

Response

A response contains a Deposit Method Restriction object providing information about the specified deposit method restriction.

Add a new deposit method restriction

Use this method to add a new restriction for a specified deposit method.

Request

Header parameters:

Authorization: Bearer <access_token>

Path parameters:

methodId required: The identifier of a deposit method for which you want to add a restriction.

Body:

Specify the following parameters when adding a new deposit method restriction:

name string required

The deposit method restriction name. Possible values:

country — allows or forbids the use of a deposit method for specified countries.
client_type — allows or forbids the use of a deposit method for specified client types.
verification_level_restriction — allows or forbids the use of a deposit method for specified client verification levels.

isEnabled boolean required

If true, a restriction is enabled for a deposit method; otherwise, false.

type stringrequired

A string value specifying the type of a deposit method restriction. Possible values:

allow
deny

ids array

An array of integer values identifying the countries, client types or client verification levels to which a restriction applies.

POST[host]/api/v2/deposits/methods/{methodId}/restrictions

curl --location --request POST 'https://host.name/api/v2/deposits/methods/1/restrictions' \
--header 'Authorization: Bearer <token>' \
--data-raw '{
  "name": "client_type",
  "isEnabled": true,
  "type": "allow",
  "ids": [
    "3",
    "44"
  ]
}'

Response

A response includes a Deposit Method Restriction object providing information about the added deposit method restriction.

Update a deposit method restriction

Use this method to update a specified deposit method restriction.

Note

Instead of the method described below, you can use a similar method that uses the HTTP verb PATCH.

Request

Header parameters:

Authorization: Bearer <access_token>

Path parameters:

methodId required: The identifier of a deposit method for which you want to update a restriction.
restrictionId required: The identifier of a deposit method restriction to be updated.

Body:

Specify the following parameters when updating a deposit method restriction:

isEnabled boolean

If true, a restriction is enabled for a deposit method; otherwise, false.

type string

A string value specifying the type of a deposit method restriction. Possible values:

allow
deny

ids array

An array of integer values identifying the countries, client types or client verification levels to which a restriction applies.

PUT[host]/api/v2/deposits/methods/{methodId}/restrictions/{restrictionId}

curl --location --request PUT 'https://host.name/api/v2/deposits/methods/1/restrictions/22' \
--header 'Authorization: Bearer <token>' \
--data-raw '{
  "isEnabled": true,
  "type": "deny",
  "ids": [
    "3",
    "41"
  ]
}'

Response

A response includes a Deposit Method Restriction object providing information about the deposit method restriction that was updated.

Delete a deposit method restriction

Use this method to remove a restriction for a specified deposit method.

Request

Header parameters:

Authorization: Bearer <access_token>

Path parameters:

methodId required: The deposit method identifier.
restrictionId required: The identifier of a deposit method restriction to be removed.

DELETE[host]/api/v2/deposits/methods/{methodId}/restrictions/{restrictionId}

curl --location --request DELETE 'https://host.name/api/v2/deposits/methods/1/restrictions/22' \
--header 'Authorization: Bearer <token>'

Response

In case of success, no response body is returned.