BlockonomicsAPI Reference

Stores

Create and manage merchant stores, configure callback URLs, and attach wallets to accept Bitcoin payments.

8 endpoints

Endpoints

List all stores
GET/v2/stores
Create a new store
POST/v2/stores
Get store details
GET/v2/stores/{id}
Update a store
POST/v2/stores/{id}
Delete store
DELETE/v2/stores/{id}
Get store wallets
GET/v2/stores/{id}/wallets
Attach wallet to store
POST/v2/stores/{id}/wallets
Detach wallet from store
DELETE/v2/stores/{id}/wallets/{wallet_id}
object

The store object

A store represents a merchant storefront. Each store has a callback URL and can have one or more wallets attached to it.

Attributes

idinteger

Unique identifier of the store

namestring

Given name

emailidstring

Email of the store owner

http_callbackstring

Callback URL of the store

walletsarray of objects
▶Show item fields
idinteger

Unique identifier of the wallet

namestring

Given name

emailidstring

Email of the wallet owner

cryptostring

Cryptocurrency of the wallet

addressstring

Address of the wallet

xpub_indexinteger

The current xPub index for BTC wallet

gap_limitinteger

The gap limit for BTC wallet

created_atstring (date-time)

Datetime of the wallet creation

balanceobject

Aggregate wallet balance (only present when balance=true is requested).

▶Show nested fields
confirmed_satsinteger

Confirmed balance in satoshis.

unconfirmed_satsinteger

Unconfirmed balance in satoshis.

confirmed_fiatnumber

Confirmed balance in fiat currency.

unconfirmed_fiatnumber

Unconfirmed balance in fiat currency.

fiat_currencystring

Fiat currency code.

total_addressesinteger

Total number of derived addresses.

Example object

{
  "id": 0,
  "name": "",
  "emailid": "",
  "http_callback": "",
  "wallets": [
    {
      "id": 0,
      "name": "",
      "emailid": "",
      "crypto": "",
      "address": "",
      "xpub_index": 0,
      "gap_limit": 0,
      "created_at": "2024-01-01T00:00:00Z",
      "balance": {
        "confirmed_sats": 0,
        "unconfirmed_sats": 0,
        "confirmed_fiat": 0,
        "unconfirmed_fiat": 0,
        "fiat_currency": "",
        "total_addresses": 0
      }
    }
  ]
}
GET/v2/storesAuth required

List all stores

Returns a list of all stores associated with your Blockonomics account.

Requires Bearer token authentication. Include Authorization: Bearer YOUR_API_KEY in the request header.

Query Parameters

walletsbooleandefault: false

Whether to include details of attached wallets

Responses

dataarray[]View store object
walletsquery · boolean

Whether to include details of attached wallets

Response will appear here

POST/v2/storesAuth required

Create a new store

Create a new store in your Blockonomics account.

Requires Bearer token authentication. Include Authorization: Bearer YOUR_API_KEY in the request header.

Request Body

namestring

Name of the store

http_callbackstringrequired

Website's callback URL

Responses

dataobjectView store
namebody · string

Name of the store

http_callbackbody · stringrequired

Website's callback URL

Response will appear here

GET/v2/stores/{id}Auth required

Get store details

Returns details of a specific store.

Requires Bearer token authentication. Include Authorization: Bearer YOUR_API_KEY in the request header.

Path Parameters

idintegerrequired

The unique ID of the store

Responses

dataobjectView store
idpath · integerrequired

The unique ID of the store

Response will appear here

POST/v2/stores/{id}Auth required

Update a store

Update the details of a specific store.

Requires Bearer token authentication. Include Authorization: Bearer YOUR_API_KEY in the request header.

Path Parameters

idintegerrequired

The unique ID of the store

Request Body

namestring

New name for the store

http_callbackstring

New callback URL for the store

Responses

dataobjectView store
idpath · integerrequired

The unique ID of the store

namebody · string

New name for the store

http_callbackbody · string

New callback URL for the store

Response will appear here

DELETE/v2/stores/{id}Auth required

Delete store

Delete a store from your Blockonomics account.

Requires Bearer token authentication. Include Authorization: Bearer YOUR_API_KEY in the request header.

Path Parameters

idintegerrequired

The unique ID of the store

Responses

idpath · integerrequired

The unique ID of the store

Response will appear here

GET/v2/stores/{id}/walletsAuth required

Get store wallets

Returns a list of wallets attached to a specific store.

Requires Bearer token authentication. Include Authorization: Bearer YOUR_API_KEY in the request header.

Path Parameters

idintegerrequired

The unique ID of the store

Responses

dataarray[]View wallet object
idpath · integerrequired

The unique ID of the store

Response will appear here

POST/v2/stores/{id}/walletsAuth required

Attach wallet to store

Attach an existing wallet in your Blockonomics account to a specific store.

Requires Bearer token authentication. Include Authorization: Bearer YOUR_API_KEY in the request header.

Path Parameters

idintegerrequired

The unique ID of the store

Request Body

wallet_idintegerrequired

The unique ID of the wallet to attach

Responses

idpath · integerrequired

The unique ID of the store

wallet_idbody · integerrequired

The unique ID of the wallet to attach

Response will appear here

DELETE/v2/stores/{id}/wallets/{wallet_id}Auth required

Detach wallet from store

Detach a wallet from a specific store.

Requires Bearer token authentication. Include Authorization: Bearer YOUR_API_KEY in the request header.

Path Parameters

idintegerrequired

The unique ID of the store

wallet_idintegerrequired

The unique ID of the wallet to detach

Responses

idpath · integerrequired

The unique ID of the store

wallet_idpath · integerrequired

The unique ID of the wallet to detach

Response will appear here