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
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334

# \LightningStoreApi

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

Method | HTTP request | Description
------------- | ------------- | -------------
[**store_lightning_node_api_connect_to_node**](LightningStoreApi.md#store_lightning_node_api_connect_to_node) | **POST** /api/v1/stores/{storeId}/lightning/{cryptoCode}/connect | Connect to lightning node
[**store_lightning_node_api_create_invoice**](LightningStoreApi.md#store_lightning_node_api_create_invoice) | **POST** /api/v1/stores/{storeId}/lightning/{cryptoCode}/invoices | Create lightning invoice
[**store_lightning_node_api_get_balance**](LightningStoreApi.md#store_lightning_node_api_get_balance) | **GET** /api/v1/stores/{storeId}/lightning/{cryptoCode}/balance | Get node balance
[**store_lightning_node_api_get_channels**](LightningStoreApi.md#store_lightning_node_api_get_channels) | **GET** /api/v1/stores/{storeId}/lightning/{cryptoCode}/channels | Get channels
[**store_lightning_node_api_get_deposit_address**](LightningStoreApi.md#store_lightning_node_api_get_deposit_address) | **POST** /api/v1/stores/{storeId}/lightning/{cryptoCode}/address | Get deposit address
[**store_lightning_node_api_get_info**](LightningStoreApi.md#store_lightning_node_api_get_info) | **GET** /api/v1/stores/{storeId}/lightning/{cryptoCode}/info | Get node information
[**store_lightning_node_api_get_invoice**](LightningStoreApi.md#store_lightning_node_api_get_invoice) | **GET** /api/v1/stores/{storeId}/lightning/{cryptoCode}/invoices/{id} | Get invoice
[**store_lightning_node_api_get_payment**](LightningStoreApi.md#store_lightning_node_api_get_payment) | **GET** /api/v1/stores/{storeId}/lightning/{cryptoCode}/payments/{paymentHash} | Get payment
[**store_lightning_node_api_open_channel**](LightningStoreApi.md#store_lightning_node_api_open_channel) | **POST** /api/v1/stores/{storeId}/lightning/{cryptoCode}/channels | Open channel
[**store_lightning_node_api_pay_invoice**](LightningStoreApi.md#store_lightning_node_api_pay_invoice) | **POST** /api/v1/stores/{storeId}/lightning/{cryptoCode}/invoices/pay | Pay Lightning Invoice



## store_lightning_node_api_connect_to_node

> store_lightning_node_api_connect_to_node(crypto_code, store_id, connect_to_node_request)
Connect to lightning node

Connect to another lightning node.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**crypto_code** | **String** | The cryptoCode of the lightning-node to query | [required] |
**store_id** | **String** | The store id with the lightning-node configuration to query | [required] |
**connect_to_node_request** | [**ConnectToNodeRequest**](ConnectToNodeRequest.md) |  | [required] |

### Return type

 (empty response body)

### 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_lightning_node_api_create_invoice

> crate::models::LightningInvoiceData store_lightning_node_api_create_invoice(crypto_code, store_id, create_lightning_invoice_request)
Create lightning invoice

Create a lightning invoice.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**crypto_code** | **String** | The cryptoCode of the lightning-node to query | [required] |
**store_id** | **String** | The store id with the lightning-node configuration to query | [required] |
**create_lightning_invoice_request** | [**CreateLightningInvoiceRequest**](CreateLightningInvoiceRequest.md) |  | [required] |

### Return type

[**crate::models::LightningInvoiceData**](LightningInvoiceData.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_lightning_node_api_get_balance

> crate::models::LightningNodeBalanceData store_lightning_node_api_get_balance(crypto_code, store_id)
Get node balance

View balance of the lightning node

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**crypto_code** | **String** | The cryptoCode of the lightning-node to query | [required] |
**store_id** | **String** | The store id with the lightning-node configuration to query | [required] |

### Return type

[**crate::models::LightningNodeBalanceData**](LightningNodeBalanceData.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_lightning_node_api_get_channels

> Vec<crate::models::LightningChannelData> store_lightning_node_api_get_channels(crypto_code, store_id)
Get channels

View information about the current channels of the lightning node

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**crypto_code** | **String** | The cryptoCode of the lightning-node to query | [required] |
**store_id** | **String** | The store id with the lightning-node configuration to query | [required] |

### Return type

[**Vec<crate::models::LightningChannelData>**](LightningChannelData.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_lightning_node_api_get_deposit_address

> String store_lightning_node_api_get_deposit_address(crypto_code, store_id)
Get deposit address

Get an on-chain deposit address for the lightning node 

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**crypto_code** | **String** | The cryptoCode of the lightning-node to query | [required] |
**store_id** | **String** | The store id with the lightning-node configuration to query | [required] |

### Return type

**String**

### 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_lightning_node_api_get_info

> crate::models::LightningNodeInformationData store_lightning_node_api_get_info(crypto_code, store_id)
Get node information

View information about the lightning node

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**crypto_code** | **String** | The cryptoCode of the lightning-node to query | [required] |
**store_id** | **String** | The store id with the lightning-node configuration to query | [required] |

### Return type

[**crate::models::LightningNodeInformationData**](LightningNodeInformationData.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_lightning_node_api_get_invoice

> crate::models::LightningInvoiceData store_lightning_node_api_get_invoice(crypto_code, store_id, id)
Get invoice

View information about the requested lightning invoice

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**crypto_code** | **String** | The cryptoCode of the lightning-node to query | [required] |
**store_id** | **String** | The store id with the lightning-node configuration to query | [required] |
**id** | **String** | The id of the lightning invoice. | [required] |

### Return type

[**crate::models::LightningInvoiceData**](LightningInvoiceData.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_lightning_node_api_get_payment

> crate::models::LightningPaymentData store_lightning_node_api_get_payment(crypto_code, store_id, payment_hash)
Get payment

View information about the requested lightning payment

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**crypto_code** | **String** | The cryptoCode of the lightning-node to query | [required] |
**store_id** | **String** | The store id with the lightning-node configuration to query | [required] |
**payment_hash** | **String** | The payment hash of the lightning payment. | [required] |

### Return type

[**crate::models::LightningPaymentData**](LightningPaymentData.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_lightning_node_api_open_channel

> store_lightning_node_api_open_channel(crypto_code, store_id, open_lightning_channel_request)
Open channel

Open a channel with another lightning node. You should connect to that node first.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**crypto_code** | **String** | The cryptoCode of the lightning-node to query | [required] |
**store_id** | **String** | The store id with the lightning-node configuration to query | [required] |
**open_lightning_channel_request** | [**OpenLightningChannelRequest**](OpenLightningChannelRequest.md) |  | [required] |

### Return type

 (empty response body)

### 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_lightning_node_api_pay_invoice

> crate::models::LightningPaymentData store_lightning_node_api_pay_invoice(crypto_code, store_id, pay_lightning_invoice_request)
Pay Lightning Invoice

Pay a lightning invoice.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**crypto_code** | **String** | The cryptoCode of the lightning-node to query | [required] |
**store_id** | **String** | The store id with the lightning-node configuration to query | [required] |
**pay_lightning_invoice_request** | [**PayLightningInvoiceRequest**](PayLightningInvoiceRequest.md) |  | [required] |

### Return type

[**crate::models::LightningPaymentData**](LightningPaymentData.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)