You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: reference/merchant.v1.yaml
+66-31Lines changed: 66 additions & 31 deletions
Original file line number
Diff line number
Diff line change
@@ -18,6 +18,29 @@ servers:
18
18
- url: 'https://api.settle.eu/merchant/v1'
19
19
description: Production
20
20
paths:
21
+
/api_key:
22
+
get:
23
+
summary: merchant.apiKeys.list
24
+
tags: []
25
+
responses: {}
26
+
operationId: merchant.apiKeys.list
27
+
description: List Merchant API Keys
28
+
post:
29
+
summary: merchant.apiKeys.create
30
+
operationId: merchant.apiKeys.create
31
+
responses:
32
+
'201':
33
+
$ref: '#/components/responses/apiKeys.create.201'
34
+
'400':
35
+
description: Bad Request
36
+
'409':
37
+
description: 'Conflict, Api key already exists.'
38
+
description: Create API Key for the Merchant given in the X-Settle-Merchant header.
39
+
requestBody:
40
+
content:
41
+
application/json:
42
+
schema:
43
+
$ref: '#/components/schemas/apiKeys.create'
21
44
/payment_request:
22
45
post:
23
46
summary: merchant.payment.request.create
@@ -709,13 +732,6 @@ paths:
709
732
examples: {}
710
733
operationId: merchant.balance.get
711
734
description: Get Merchant Account Balance
712
-
/api_key:
713
-
get:
714
-
summary: merchant.apiKeys.list
715
-
tags: []
716
-
responses: {}
717
-
operationId: merchant.apiKeys.list
718
-
description: List Merchant API Keys
719
735
components:
720
736
schemas:
721
737
payment.request.create:
@@ -1261,7 +1277,7 @@ components:
1261
1277
default: 'null'
1262
1278
description: URI called by Settle when user scans shortlink.
1263
1279
ssp.users.create:
1264
-
title: ssp.users.create
1280
+
title: 'Request Body: ssp.users.create'
1265
1281
type: object
1266
1282
description: 'Creates a MerchantSspUser and returns 201 CREATED (unless a user with the same email already exists, which results in a 409 CONFLICT response).'
1267
1283
properties:
@@ -1277,54 +1293,64 @@ components:
1277
1293
$ref: ../models/Name.yaml
1278
1294
required:
1279
1295
- email
1280
-
users.create:
1281
-
title: users.create
1296
+
apiKeys.update:
1297
+
title: 'Request Body: users.update'
1282
1298
type: object
1283
-
description: Create user for the Merchant given in the X-Settle-Merchant header.
1299
+
description: Update API Key
1284
1300
properties:
1285
-
id:
1286
-
type: string
1287
-
default: 'null'
1288
-
description: User ID
1289
1301
netmask:
1290
1302
type: string
1291
-
default: 'null'
1292
1303
description: 'Limit user connections by netmask, for example 192.168.1.0/24'
1293
1304
format: ipv4
1294
1305
example: 192.168.1.0/24
1295
1306
label:
1296
1307
type: string
1297
-
default: 'null'
1298
-
description: User given name to RSA key/secret
1308
+
description: User given name to RSA key/secret.
1299
1309
secret:
1300
1310
type: string
1301
-
default: 'null'
1302
-
description: Secret used when authenticating with Settle.
1303
1311
minLength: 8
1304
1312
maxLength: 64
1313
+
description: Secret used when authenticating with Settle.
1305
1314
pubkey:
1306
1315
$ref: ../models/PubKey.yaml
1307
-
users.update:
1308
-
title: users.update
1316
+
x-examples: {}
1317
+
apiKeys.create:
1318
+
title: 'Request Body: apiKeys.create'
1309
1319
type: object
1310
-
description: Update user
1320
+
description: Create API Key
1321
+
x-examples: {}
1311
1322
properties:
1312
-
netmask:
1323
+
id:
1313
1324
type: string
1314
-
description: 'Limit user connections by netmask, for example 192.168.1.0/24'
1315
-
format: ipv4
1316
-
example: 192.168.1.0/24
1317
-
label:
1325
+
description: User ID
1326
+
key_type:
1318
1327
type: string
1319
-
description: User given name to RSA key/secret.
1328
+
enum:
1329
+
- secret
1330
+
- rsa_generated
1331
+
- rsa_user
1332
+
description: Type of API Key to create.
1333
+
roles:
1334
+
type: string
1335
+
description: 'Role. Value in user, superuser (case insensitive).'
1336
+
enum:
1337
+
- user
1338
+
- superuser
1339
+
- integrator
1340
+
default: 'null'
1341
+
netmask:
1342
+
type: string
1343
+
description: 'Limit user connections by netmask, for example 192.168.1.0/24.'
1320
1344
secret:
1321
1345
type: string
1346
+
description: Secret used when authenticating with Settle.
1322
1347
minLength: 8
1323
1348
maxLength: 64
1324
-
description: Secret used when authenticating with Settle.
0 commit comments