Deposit methods

Use these methods to obtain data about deposit methods, groups and currencies available to clients in the B2Core UI.

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

Get a list of deposit methods

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

Get deposit method details

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

Get a list of deposit groups

GET[host]/api/v2/my/deposits/currencies

Get a list of currencies added to deposit methods

Get a list of deposit methods

Use this method to obtain a list of available deposit methods.

Use a separate method to get deposit method details.

Request

Header parameters:

  • Authorization: Bearer <access_token>

Query parameters:

The following filter parameters are available for this method:

groupId

The identifier of a group in which a deposit method is included.

tradersRoomCurrencyNumericCode

The numeric code of a currency that is added as a transaction currency to a deposit method.

paymentSystemCurrencyNumericCode

The numeric code of a currency that is added as a payment currency 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/my/deposits/methods

curl --location -g --request GET 'https://host.name/api/v2/my/deposits/methods?sort_order=desc&filter[groupId]=1&filter[tradersRoomCurrencyNumericCode]=840&filter[paymentSystemCurrencyNumericCode]=840&sort_by=createTime' \
--header 'Authorization: Bearer <token>'

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.

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

Request

Path parameters:

methodId required

The identifier of a deposit method.

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

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

Response

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

Get a list of deposit groups

Use this method to obtain a list of available deposit groups that are used to categorize configured deposit methods.

Request

Header parameters:

  • Authorization: Bearer <access_token>

Query parameters:

The following sorting parameter is available for this method:

priority

The priority index assigned to a deposit group.

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

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

curl --location --request GET 'https://host.name/api/v2/my/deposits/groups?sort_order=desc&sort_by=priority' \
--header 'Authorization: Bearer <token>'

Response

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

Get a list of currencies added to deposit methods

Use this method to obtain a list of enabled transaction and payment currencies added to the deposit methods available in the B2Core UI.

Request

Header parameters:

  • Authorization: Bearer <access_token>

Query parameters:

The following filter parameters are available for this method:

groupId

The identifier of a deposit group for which you want to get a list of available currencies.

type

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

  • tradersRoom — transaction currencies

  • paymentSystem — payment currencies

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.

GET[host]/api/v2/my/deposits/currencies

curl --location -g --request GET 'https://host.name/api/v2/my/deposits/currencies?sort_order=desc&sort_by=createTime&filter[groupId]=1&filter[type]=tradersRoom' \
--header 'Authorization: Bearer <token>'

Response

A response contains the following data about each currency matching the request parameters:

alphabeticCode string

The alphabetic code of a currency (such as USD).

minorUnit integer

The number of decimal places displayed when representing amounts in a currency.

name string

The currency name.

numericCode integer

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

RESPONSE EXAMPLE
{
  "alphabeticCode": "USD",
  "minorUnit": 2,
  "name": "US Dollar",
  "numericCode": 840
}