sbcapi24/ln-pay-api.yaml at develop · bitagentch/sbcapi24 · GitHub

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
openapi: 3.0.3

info:
  title: LnPayApi
  version: 0.0.1

servers:
  - url: https://lnpay.onrender.com/api
  - url: http://localhost:3000/api

tags:
  - name: Ping
  - name: Pay

paths:
  /ping:
    get:
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PingResponse'
      tags:
        - Ping

  /lightning-address/{address}:
    get:
      parameters:
        - $ref: '#/components/parameters/LightningAddressParam'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LightningAddressResponse'
      tags:
        - Pay

  /pay-request:
    post:
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PayRequest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayResponse'
      tags:
        - Pay

components:
  parameters:
    LightningAddressParam:
      name: address
      in: path
      required: true
      schema:
        type: string
        example: beat@bitagent.ch

  schemas:
    PingResponse:
      type: object
      properties:
        response:
          type: string
          example: pong

    LightningAddressResponse:
      type: object
      properties:
        payRequest:
          type: boolean
          default: false
        minSendable:
          type: number
        maxSendable:
          type: number
        commentAllowed:
          type: number
        callback:
          type: string

    PayRequest:
      type: object
      properties:
        callback:
          type: string
        amount:
          type: number
        comment:
          type: string
      required:
        - callback
        - amount

    PayResponse:
      type: object
      properties:
        payRequest:
          type: string
        qrCode:
          type: string