Whitelisted withdrawal addresses
Use these methods to get data about the withdrawal addresses that clients added to their whitelists.
After clients enable the address management option in the B2Core UI, they can make withdrawals only to the addresses that they added to their whitelists.
GET[host]/api/v2/withdrawals/policies |
|
GET[host]/api/v2/withdrawals/policies/{policyId} |
Get a list of whitelisted withdrawal addresses
Use this method to obtain a list of withdrawal addresses added to client whitelists.
Note
If such a request is made by an admin user that is only permitted to view clients with certain tags, a response includes only the withdrawal addresses that are whitelisted by clients marked with these tags.
To obtain detailed information about a specific whitelisted withdrawal address, use a separate method to get whitelisted address details.
Request
Header parameters:
Authorization: Bearer <access_token>
Query parameters:
The following filter parameters are available for this method:
- clientId
The client identifier.
- walletAddress
A string value identifying the address of a wallet that is used for withdrawing funds.
- currencyCode
The numeric code of the currency in which a wallet for withdrawing funds is denominated.
- isEnabled boolean
If
true, the address management option is enabled by a client in the B2Core UI; otherwise,false.This option allows clients to add withdrawal addresses to their whitelists and withdraw funds only to the whitelisted addresses.
The following sorting parameter is available for this method:
- walletAddress
A string value identifying the address of a wallet that is used for withdrawing funds.
Refer to the Query parameters section in the API Overview for details on applying filter and sorting parameters.
GET[host]/api/v2/withdrawals/policies
curl --location -g 'https://host.name/api/v2/withdrawals/policies?limit=10&offset=0&sort_by=walletAddress&filter[clientId]=1&filter[walletAddress]=3J98t1WpEZ73CNmQviecrnyiWrnqRhWNLi&filter[currencyCode]=1000' \
--header 'Authorization: Bearer <token>' \
--header 'accept-language: ja'
Response
A response contains an array of Whitelisted Address objects providing information about the whitelisted addresses matching the request parameters.
Get whitelisted withdrawal address details
Use this method to obtain detailed information about a specified withdrawal address added to a client whitelist.
To obtain a full list of withdrawal addresses added to client whitelists, use a separate method to get whitelisted addresses.
Request
Header parameters:
Authorization: Bearer <access_token>
Path parameters:
- policyId required
The identifier of a whitelisted withdrawal address.
GET[host]/api/v2/withdrawals/policies/{policyId}
curl --location -g 'https://host.name/api/v2/withdrawals/policies/1' \
--header 'Authorization: Bearer <token>' \
--header 'accept-language: ja'
Response
A response contains a Whitelisted Address object providing information about the specified whitelisted address.