Home B2Core IB API Wallets

Wallets

Use these methods to obtain information about wallets.

THE WALLET OBJECT

A detailed description of the JSON object

GET[base]/wallets

Get a wallets list

GET[base]/wallets/{walletId}

Get wallet details

POST[base]/wallets

Add a new wallet

PUT[base]//wallets/{walletId}

Update a wallet

DELETE[base]/wallets/{walletId}

Delete a wallet

The Wallet object

This object provides the following data about a wallet of your partner:

walletId string

The wallet identifier.

methodId string

The payment method identifier.

number string

The wallet number.

currencyCode string

The alphabetic code of a wallet currency.

currencyPrecision integer

The minor unit of a currency (the number of digits after the decimal separator).

currencySign string

The currency sign.

totalPaymentAmount string

The amount of rewards credited to this wallet.

userId string

The partner identifier.

profileId string

The client profile identifier.

createTime string

The date and time when the object has been created.

updateTime string

The date and time when the object has been last updated.

uuid string

The universally unique identifier of the object (if provided). Refer to Integrations for more information.

THE WALLET OBJECT 
{
  "walletId": "6006dda272f002519c3eb505",
  "methodId": "6006dda272f002519c3eb505",
  "number": "12345",
  "currencyCode": "BTC",
  "currencyPrecision": 8,
  "currencySign": "₿",
  "totalPaymentAmount": "2.14285602",
  "userId": "6006dda272f002519c3eb505",
  "profileId": "6006dda272f002519c3eb505",
  "createTime": "2021-01-01T00:00:00+00:00",
  "updateTime": "2021-01-01T00:00:00+00:00",
  "uuid": null
}

Get a wallets list

Use this method to obtain a list of wallets of your partners.

To obtain detailed information about a specified wallet, use a separate method to get wallet details.

Request

Header parameters:

  • Authorization: Bearer <token>

Query parameters:

This method supports pagination, sorting, filtering, and query. For details on applying the parameters, refer to the Query parameters section. Possible parameters for filtering, sorting, and query are listed below. For values description, refer to the Wallet object.

Possible values for the filter parameter:

  • currencyCode

  • methodId

  • number

  • profileId

  • uuid

  • userId

  • userName

  • userEmail

Possible values for the sort_by parameter:

  • createTime

  • currencyCode

  • number

  • updateTime

  • walletId

Possible values for the query parameter:

  • method — payment method information

  • profile — user profile information

  • contacts — user contact details

GET[base]/wallets

curl --location -g --request GET 'https://your.base-url.here/wallets?limit=10&offset=0&sort_by=createTime&sort_order=desc&filter[currencyCode]=BTC&filter[methodId]=6006dda272f002519c3eb505&filter[number]=12345&filter[profileId]=6006dda272f002519c3eb505&filter[uuid]=9&filter[userId]=6006dda272f002519c3eb505&filter[userName]=Mary Jane Smith&filter[userEmail]=a31b1402@privaterelay.appleid.com&query[method]=1&query[group]=1&query[profile]=1&query[contacts]=1' \
--header 'Authorization: Bearer <token>'

Response

Body:

In case of success, the response body contains an array of Wallet objects providing information about all wallets that correspond to the query parameters specified in the request.

Additionally, the response body may contain the following information, if any of these were specified in the query parameters of the request:

Get wallet details

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

To obtain a list of wallets, use a separate method to get a list of wallets.

Request

Header parameters:

  • Authorization: Bearer <token>

Path parameters:

walletId required

The wallet identifier.

Query parameters:

This method supports query. For details on applying the parameters, refer to the Query parameters section.

Possible values for the query parameter:

  • method — payment method information

  • profile — user profile information

  • contacts — user contact details

GET[base]/wallets/:path-param`{walletId}`

curl --location -g --request GET 'https://your.base-url.here/wallets/60ba407d15951453e60e49f8?query[method]=1&query[group]=1&query[profile]=1&query[contacts]=1' \
--header 'Authorization: Bearer <token>'

Response

Body:

In case of success, the response body contains a Wallet object providing information about the specified wallet.

Additionally, the response body may contain the following information, if any of these were specified in the query parameters of the request:

Add a new wallet

Use this method to add a new partner wallet.

Request

Header parameters:

  • Authorization: Bearer <token>

  • Content-Type: application/json

Body:

methodId string required

The payment method identifier.

number string

The wallet number.

currencyCode string

The alphabetic code of a wallet currency.

userId string required

The partner identifier.

uuid string

The universally unique identifier of the object. Refer to Integrations for more information.

POST[base]v1/wallets

curl --location -g --request POST 'https://your.base-url.here/wallets' \
--header 'Authorization: Bearer <token>' \
--data-raw '{
  "methodId": "6006dda272f002519c3eb505",
  "userId": "6006dda272f002519c3eb505",
  "currencyCode": "BTC",
  "number": "12345",
  "uuid": null
}'

Response

Body:

In case of success, the response body contains a Wallet object providing information about the newly created wallet.

Update a wallet

Use this method to update the information about a specified wallet.

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:

walletId required

The wallet identifier.

Body:

number string

The wallet number.

uuid string

The universally unique identifier of the object. Refer to Integrations for more information.

PUT[base]/wallets/{walletId}

curl --location -g --request PUT 'https://your.base-url.here/wallets/60ba407d15951453e60e49f8' \
--header 'Authorization: Bearer <token>' \
--data-raw '{
  "number": "12345",
  "uuid": null
}'

Response

Body:

In case of success, the response body contains a Wallet object providing information about the updated wallet.

Delete a wallet

Use this method to delete a specified wallet.

Request

Header parameters:

  • Authorization: Bearer <token>

Path parameters:

walletId required

The wallet identifier.

DELETE[base]/wallets/{walletId}

curl --location --request DELETE 'https://your.base-url.here/wallets/60ba407d15951453e60e49f8' \
--header 'Authorization: Bearer <token>'

Response

Body:

In case of success, no response body is returned.