StoresApi.md

\StoresApi

All URIs are relative to https://btcpay.example.com/api/v1

Method	HTTP request	Description
stores_create_store	POST /api/v1/stores	Create a new store
stores_delete_store	DELETE /api/v1/stores/{storeId}	Remove Store
stores_get_store	GET /api/v1/stores/{storeId}	Get store
stores_get_stores	GET /api/v1/stores	Get stores
stores_update_store	PUT /api/v1/stores/{storeId}	Update store

stores_create_store

crate::models::StoreData stores_create_store(store_base_data) Create a new store

Create a new store

Parameters

Name	Type	Description	Required	Notes
store_base_data	StoreBaseData		[required]

Return type

crate::models::StoreData

Authorization

API_Key, Basic

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

stores_delete_store

stores_delete_store(store_id) Remove Store

Removes the specified store. If there is another user with access, only your access will be removed.

Parameters

Name	Type	Description	Required	Notes
store_id	String	The store to remove	[required]

Return type

(empty response body)

Authorization

API_Key, Basic

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

stores_get_store

crate::models::StoreData stores_get_store(store_id) Get store

View information about the specified store

Parameters

Name	Type	Description	Required	Notes
store_id	String	The store to fetch	[required]

Return type

crate::models::StoreData

Authorization

API_Key, Basic

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

stores_get_stores

Veccrate::models::StoreData stores_get_stores() Get stores

View information about the available stores

Parameters

This endpoint does not need any parameter.

Return type

Veccrate::models::StoreData

Authorization

API_Key, Basic

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

stores_update_store

crate::models::StoreData stores_update_store(store_id, store_data) Update store

Update the specified store

Parameters

Name	Type	Description	Required	Notes
store_id	String	The store to update	[required]
store_data	StoreData		[required]

Return type

crate::models::StoreData

Authorization

API_Key, Basic

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]