-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathinterface.json
More file actions
221 lines (221 loc) · 7.65 KB
/
interface.json
File metadata and controls
221 lines (221 loc) · 7.65 KB
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
{
"swagger": "2.0",
"info": {
"title": "PaymentChannelServer.",
"version": "1.0.0"
},
"host": "localhost:8085",
"schemes": [
"http"
],
"basePath": "/v1",
"consumes": [
"application/json"
],
"produces": [
"application/json",
"text/plain"
],
"paths": {
"/invoices": {
"post": {
"summary": "Add one new invoice.",
"operationId": "addInvoice",
"parameters": [
{
"name": "invoice",
"description": "one new invoice",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/Invoice"
}
}
],
"responses": {
"201": {
"description": "id of new invoice",
"schema": {
"$ref": "#/definitions/Invoice"
},
"headers": {
"Location": {
"description": "the absolute path to the created resource",
"type": "string"
}
}
},
"400": {
"description": "bad request",
"schema": {
"$ref": "#/definitions/Error"
}
},
"503": {
"description": "service unavailable",
"schema": {
"$ref": "#/definitions/Error"
}
}
}
},
"get": {
"summary": "The invoices endpoint returns a list of all known invoices ids.",
"operationId": "getInvoices",
"responses": {
"200": {
"description": "an array of invoice ids",
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"description": "unique id of the invoice assigned by payment service"
}
}
}
}
}
},
"/invoices/{invoiceId}": {
"get": {
"summary": "Returns information about the invoice to the provided id.",
"operationId": "getInvoiceById",
"parameters": [
{
"name": "invoiceId",
"in": "path",
"type": "string",
"format": "uuid",
"required": true,
"description": "the invoice id to get the information for"
}
],
"responses": {
"200": {
"description": "returns the information about the invoice",
"schema": {
"$ref": "#/definitions/Invoice"
}
},
"404": {
"description": "invoice not found",
"schema": {
"$ref": "#/definitions/Error"
}
}
}
},
"delete": {
"summary": "Deletes the invoice to the provided ID.",
"operationId": "deleteInvoiceById",
"parameters": [
{
"name": "invoiceId",
"in": "path",
"type": "string",
"format": "uuid",
"required": true,
"description": "the id of the invoice to delete"
}
],
"responses": {
"200": {
"description": "invoice deleted"
},
"404": {
"description": "invoice not found",
"schema": {
"$ref": "#/definitions/Error"
}
}
}
}
},
"/invoices/{invoiceId}/state": {
"get": {
"summary": "Returns a confidence object that describes the state of the incoming tx.",
"operationId": "getInvoiceState",
"parameters": [
{
"name": "invoiceId",
"in": "path",
"type": "string",
"format": "uuid",
"required": true,
"description": "the invoice id to get the state for"
}
],
"responses": {
"200": {
"description": "returns the state object of the incoming tx",
"schema": {
"$ref": "#/definitions/State"
}
},
"404": {
"description": "invoice not found",
"schema": {
"$ref": "#/definitions/Error"
}
}
}
}
}
},
"definitions": {
"Invoice": {
"type": "object",
"properties": {
"totalAmount": {
"type": "integer",
"format": "int64",
"description": "total amount of Satoshis that are requested to be paid"
},
"expiration": {
"type": "string",
"format": "date-time",
"description": "date after which this invoice is no longer valid'"
},
"invoiceId": {
"type": "string",
"format": "uuid",
"description": "unique id of the invoice assigned by payment service"
},
"referenceId": {
"type": "string",
"description": "id defined by the client for its internal reference, which is just stored and passed but not processed by the payment service"
}
}
},
"State": {
"description": "invoice confidence state",
"type": "object",
"properties": {
"state": {
"type": "string",
"description": "confidence state",
"default": "unpaid",
"enum": [
"unpaid",
"paid"
]
},
"depthInBlocks": {
"type": "integer",
"format": "int32",
"description": "depth of a building transaction in blocks"
}
}
},
"Error": {
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "meaningful error message"
}
}
}
}
}