btcpay-client 0.1.0

A client library for BTCPay Server.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307

# \StoreWalletOnChainApi

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

Method | HTTP request | Description
------------- | ------------- | -------------
[**store_on_chain_wallets_create_on_chain_transaction**](StoreWalletOnChainApi.md#store_on_chain_wallets_create_on_chain_transaction) | **POST** /api/v1/stores/{storeId}/payment-methods/onchain/{cryptoCode}/wallet/transactions | Create store on-chain wallet transaction
[**store_on_chain_wallets_get_on_chain_fee_rate**](StoreWalletOnChainApi.md#store_on_chain_wallets_get_on_chain_fee_rate) | **GET** /api/v1/stores/{storeId}/payment-methods/onchain/{cryptoCode}/wallet/feerate | Get store on-chain wallet fee rate
[**store_on_chain_wallets_get_on_chain_wallet_receive_address**](StoreWalletOnChainApi.md#store_on_chain_wallets_get_on_chain_wallet_receive_address) | **GET** /api/v1/stores/{storeId}/payment-methods/onchain/{cryptoCode}/wallet/address | Get store on-chain wallet address
[**store_on_chain_wallets_get_on_chain_wallet_transaction**](StoreWalletOnChainApi.md#store_on_chain_wallets_get_on_chain_wallet_transaction) | **GET** /api/v1/stores/{storeId}/payment-methods/onchain/{cryptoCode}/wallet/transactions/{transactionId} | Get store on-chain wallet transaction
[**store_on_chain_wallets_get_on_chain_wallet_utxos**](StoreWalletOnChainApi.md#store_on_chain_wallets_get_on_chain_wallet_utxos) | **GET** /api/v1/stores/{storeId}/payment-methods/onchain/{cryptoCode}/wallet/utxos | Get store on-chain wallet UTXOS
[**store_on_chain_wallets_patch_on_chain_wallet_transaction**](StoreWalletOnChainApi.md#store_on_chain_wallets_patch_on_chain_wallet_transaction) | **PATCH** /api/v1/stores/{storeId}/payment-methods/onchain/{cryptoCode}/wallet/transactions/{transactionId} | Patch store on-chain wallet transaction info
[**store_on_chain_wallets_show_on_chain_wallet_overview**](StoreWalletOnChainApi.md#store_on_chain_wallets_show_on_chain_wallet_overview) | **GET** /api/v1/stores/{storeId}/payment-methods/onchain/{cryptoCode}/wallet | Get store on-chain wallet overview
[**store_on_chain_wallets_show_on_chain_wallet_transactions**](StoreWalletOnChainApi.md#store_on_chain_wallets_show_on_chain_wallet_transactions) | **GET** /api/v1/stores/{storeId}/payment-methods/onchain/{cryptoCode}/wallet/transactions | Get store on-chain wallet transactions
[**store_on_chain_wallets_un_reserve_on_chain_wallet_receive_address**](StoreWalletOnChainApi.md#store_on_chain_wallets_un_reserve_on_chain_wallet_receive_address) | **DELETE** /api/v1/stores/{storeId}/payment-methods/onchain/{cryptoCode}/wallet/address | UnReserve last store on-chain wallet address



## store_on_chain_wallets_create_on_chain_transaction

> crate::models::StoreOnChainWalletsCreateOnChainTransaction200Response store_on_chain_wallets_create_on_chain_transaction(store_id, crypto_code, create_on_chain_transaction_request)
Create store on-chain wallet transaction

Create store on-chain wallet transaction

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**store_id** | **String** | The store to fetch | [required] |
**crypto_code** | **String** | The crypto code of the wallet | [required] |
**create_on_chain_transaction_request** | [**CreateOnChainTransactionRequest**](CreateOnChainTransactionRequest.md) |  | [required] |

### Return type

[**crate::models::StoreOnChainWalletsCreateOnChainTransaction200Response**](StoreOnChainWallets_CreateOnChainTransaction_200_response.md)

### Authorization

[API_Key](../README.md#API_Key), [Basic](../README.md#Basic)

### HTTP request headers

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

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## store_on_chain_wallets_get_on_chain_fee_rate

> crate::models::OnChainWalletFeeRateData store_on_chain_wallets_get_on_chain_fee_rate(store_id, crypto_code, block_target)
Get store on-chain wallet fee rate

Get wallet onchain fee rate

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**store_id** | **String** | The store to fetch | [required] |
**crypto_code** | **String** | The crypto code of the payment method to fetch | [required] |
**block_target** | Option<**f32**> | The number of blocks away you are willing to target for confirmation. Defaults to the wallet's configured `RecommendedFeeBlockTarget` |  |

### Return type

[**crate::models::OnChainWalletFeeRateData**](OnChainWalletFeeRateData.md)

### Authorization

[API_Key](../README.md#API_Key), [Basic](../README.md#Basic)

### HTTP request headers

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

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## store_on_chain_wallets_get_on_chain_wallet_receive_address

> crate::models::OnChainWalletAddressData store_on_chain_wallets_get_on_chain_wallet_receive_address(store_id, crypto_code, force_generate)
Get store on-chain wallet address

Get or generate address for wallet

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**store_id** | **String** | The store to fetch | [required] |
**crypto_code** | **String** | The crypto code of the payment method to fetch | [required] |
**force_generate** | Option<**bool**> | Whether to generate a new address for this request even if the previous one was not used |  |[default to false]

### Return type

[**crate::models::OnChainWalletAddressData**](OnChainWalletAddressData.md)

### Authorization

[API_Key](../README.md#API_Key), [Basic](../README.md#Basic)

### HTTP request headers

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

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## store_on_chain_wallets_get_on_chain_wallet_transaction

> crate::models::OnChainWalletTransactionData store_on_chain_wallets_get_on_chain_wallet_transaction(store_id, crypto_code, transaction_id)
Get store on-chain wallet transaction

Get store on-chain wallet transaction

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**store_id** | **String** | The store to fetch | [required] |
**crypto_code** | **String** | The crypto code of the wallet to fetch | [required] |
**transaction_id** | **String** | The transaction id to fetch | [required] |

### Return type

[**crate::models::OnChainWalletTransactionData**](OnChainWalletTransactionData.md)

### Authorization

[API_Key](../README.md#API_Key), [Basic](../README.md#Basic)

### HTTP request headers

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

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## store_on_chain_wallets_get_on_chain_wallet_utxos

> Vec<crate::models::OnChainWalletUtxoData> store_on_chain_wallets_get_on_chain_wallet_utxos(store_id, crypto_code)
Get store on-chain wallet UTXOS

Get store on-chain wallet utxos

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**store_id** | **String** | The store to fetch | [required] |
**crypto_code** | **String** | The crypto code of the wallet to fetch | [required] |

### Return type

[**Vec<crate::models::OnChainWalletUtxoData>**](OnChainWalletUTXOData.md)

### Authorization

[API_Key](../README.md#API_Key), [Basic](../README.md#Basic)

### HTTP request headers

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

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## store_on_chain_wallets_patch_on_chain_wallet_transaction

> crate::models::OnChainWalletTransactionData store_on_chain_wallets_patch_on_chain_wallet_transaction(store_id, crypto_code, transaction_id, patch_on_chain_transaction_request, force)
Patch store on-chain wallet transaction info

Patch store on-chain wallet transaction info

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**store_id** | **String** | The store to fetch | [required] |
**crypto_code** | **String** | The crypto code of the wallet to fetch | [required] |
**transaction_id** | **String** | The transaction id to fetch | [required] |
**patch_on_chain_transaction_request** | [**PatchOnChainTransactionRequest**](PatchOnChainTransactionRequest.md) |  | [required] |
**force** | Option<**String**> | Whether to update the label/comments even if the transaction does not yet exist |  |

### Return type

[**crate::models::OnChainWalletTransactionData**](OnChainWalletTransactionData.md)

### Authorization

[API_Key](../README.md#API_Key), [Basic](../README.md#Basic)

### HTTP request headers

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

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## store_on_chain_wallets_show_on_chain_wallet_overview

> crate::models::OnChainWalletOverviewData store_on_chain_wallets_show_on_chain_wallet_overview(store_id, crypto_code)
Get store on-chain wallet overview

View information about the specified wallet

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**store_id** | **String** | The store to fetch | [required] |
**crypto_code** | **String** | The crypto code of the payment method to fetch | [required] |

### Return type

[**crate::models::OnChainWalletOverviewData**](OnChainWalletOverviewData.md)

### Authorization

[API_Key](../README.md#API_Key), [Basic](../README.md#Basic)

### HTTP request headers

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

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## store_on_chain_wallets_show_on_chain_wallet_transactions

> Vec<crate::models::OnChainWalletTransactionData> store_on_chain_wallets_show_on_chain_wallet_transactions(store_id, crypto_code, status_filter, label_filter, skip, limit)
Get store on-chain wallet transactions

Get store on-chain wallet transactions

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**store_id** | **String** | The store to fetch | [required] |
**crypto_code** | **String** | The crypto code of the wallet to fetch | [required] |
**status_filter** | Option<[**Vec<crate::models::TransactionStatus>**](crate::models::TransactionStatus.md)> | Statuses to filter the transactions with |  |
**label_filter** | Option<**String**> | Transaction label to filter by |  |
**skip** | Option<**i32**> | Number of transactions to skip from the start |  |
**limit** | Option<**i32**> | Maximum number of transactions to return |  |

### Return type

[**Vec<crate::models::OnChainWalletTransactionData>**](OnChainWalletTransactionData.md)

### Authorization

[API_Key](../README.md#API_Key), [Basic](../README.md#Basic)

### HTTP request headers

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

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## store_on_chain_wallets_un_reserve_on_chain_wallet_receive_address

> store_on_chain_wallets_un_reserve_on_chain_wallet_receive_address(store_id, crypto_code)
UnReserve last store on-chain wallet address

UnReserve address

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**store_id** | **String** | The store to fetch | [required] |
**crypto_code** | **String** | The crypto code of the payment method to fetch | [required] |

### Return type

 (empty response body)

### Authorization

[API_Key](../README.md#API_Key), [Basic](../README.md#Basic)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: Not defined

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)