Withdrawal methods
Use these methods to obtain data about withdrawal methods, groups and currencies available to clients in the B2Core UI.
GET[host]/api/v2/my/withdrawals/methods |
|
GET[host]/api/v2/my/withdrawals/methods/{methodId} |
|
GET[host]/api/v2/my/withdrawals/groups |
|
GET[host]/api/v2/my/withdrawals/currencies |
Get a list of withdrawal methods
Use this method to obtain a list of available withdrawal methods.
Use a separate method to get withdrawal 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 withdrawal method is included.
- tradersRoomCurrencyNumericCode
The numeric code of a currency that is added as a transaction currency to a withdrawal method.
- paymentSystemCurrencyNumericCode
The numeric code of a currency that is added as a payment currency to a withdrawal method.
The following sorting parameter is available for this method:
- createTime
The date and time when a withdrawal 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/withdrawals/methods
curl --location -g --request GET 'https://host.name/api/v2/my/withdrawals/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 Withdrawal Method objects providing information about the withdrawal methods matching the request parameters.
Get withdrawal method details
Use this method to obtain detailed information about a specified withdrawal method.
Use a separate method to get a list of withdrawal methods.
Request
Path parameters:
- methodId required
The identifier of a withdrawal method.
GET[host]/api/v2/my/withdrawals/methods/{methodId}
curl --location --request GET 'https://host.name/api/v2/my/withdrawals/methods/1' \
--header 'Authorization: Bearer <token>'
Response
A response contains a Withdrawal Method object providing information about the specified withdrawal method.
Get a list of withdrawal groups
Use this method to obtain a list of available withdrawal groups that are used to categorize configured withdrawal 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 withdrawal group.
Refer to the Query parameters section in the API Overview for details on applying sorting parameters.
GET[host]/api/v2/my/withdrawals/groups
curl --location --request GET 'https://host.name/api/v2/my/withdrawals/groups?sort_order=desc&sort_by=priority' \
--header 'Authorization: Bearer <token>'
Response
A response contains an array of Withdrawal Group objects providing information about the withdrawal groups matching the request parameters.
Get a list of currencies added to withdrawal methods
Use this method to obtain a list of enabled transaction and payment currencies added to the withdrawal 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 withdrawal group for which you want to get a list of available currencies.
- type
The type of a currency added to a withdrawal method. Possible values:
tradersRoom
— transaction currenciespaymentSystem
— payment currencies
The following sorting parameter is available for this method:
- createTime
The date and time when a currency was added to a withdrawal method.
Refer to the Query parameters section in the API Overview for details on applying filter and sorting parameters.
GET[host]/api/v2/my/withdrawals/currencies
curl --location -g --request GET 'https://host.name/api/v2/my/withdrawals/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
BTC
).- 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
1000
).
{
"alphabeticCode": "BTC",
"minorUnit": 8,
"name": "Bitcoin",
"numericCode": 1000
}