interswitch/openapi/interswitch-paycode-api-openapi.yml at main · api-evangelist/interswitch · 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
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
openapi: 3.1.0
info:
  title: Interswitch Paycode API
  description: |
    Cardless cash and merchant tokens (Pay with Mobile / Paycode). Generate
    single or bulk one-time tokens, query token status, and cancel tokens.
    Powers cardless ATM withdrawal across the Interswitch-acquired ATM network.
  version: '2024-01-01'
servers:
  - url: https://sandbox.interswitchng.com
    description: Sandbox
  - url: https://saturn.interswitchng.com
    description: Production
security:
  - BearerAuth: []
tags:
  - name: Tokens
paths:
  /api/v1/pwm/subscribers/{subscriberId}/tokens:
    post:
      tags: [Tokens]
      summary: Generate Paycode Token
      description: Create a one-time access code for a cardless transaction.
      operationId: generatePaycodeToken
      parameters:
        - in: path
          name: subscriberId
          required: true
          schema: { type: string }
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required: [frontEndPartnerId, paymentMethodCode, amount, tokenLifeTimeInMinutes, oneTimePin]
              properties:
                frontEndPartnerId: { type: string, example: WEMA }
                paymentMethodCode: { type: string }
                amount: { type: integer }
                tokenLifeTimeInMinutes: { type: integer }
                oneTimePin: { type: string }
                ttid: { type: string, description: Use the same value as `transactionRef`. }
                transactionRef: { type: string }
      responses:
        '200':
          description: Token created.
          content:
            application/json:
              schema:
                type: object
                properties:
                  payWithMobileToken: { type: string }
                  subscriberId: { type: string }
                  tokenLifeTimeInMinutes: { type: integer }
                  responseCode: { type: string }
  /api/v1/pwm/subscribers/{subscriberId}/tokens/status:
    get:
      tags: [Tokens]
      summary: Get Token Status
      operationId: getPaycodeTokenStatus
      parameters:
        - in: path
          name: subscriberId
          required: true
          schema: { type: string }
        - in: query
          name: token
          required: true
          schema: { type: string }
      responses:
        '200':
          description: Token status.
          content:
            application/json:
              schema:
                type: object
                properties:
                  status: { type: string }
                  channel: { type: string }
                  surchargeAmount: { type: integer }
                  settlementCode: { type: string }
                  paymentMethodCode: { type: string }
  /cardless-service/api/v1/cardless-services/cancel-token:
    post:
      tags: [Tokens]
      summary: Cancel Paycode Token
      operationId: cancelPaycodeToken
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required: [referenceId, frontEndPartner]
              properties:
                referenceId: { type: string }
                frontEndPartner: { type: string }
      responses:
        '200':
          description: Cancellation response.
          content:
            application/json:
              schema:
                type: object
                properties:
                  responseCode: { type: string }
                  responseMessage: { type: string }
  /api/v1/pwm/subscribers/{subscriberId}/tokens/bulk:
    post:
      tags: [Tokens]
      summary: Generate Bulk Paycode Tokens
      operationId: generateBulkPaycodeTokens
      parameters:
        - in: path
          name: subscriberId
          required: true
          schema: { type: string }
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required: [frontEndPartnerId, items]
              properties:
                frontEndPartnerId: { type: string }
                items:
                  type: array
                  items:
                    type: object
                    properties:
                      amount: { type: integer }
                      tokenLifeTimeInMinutes: { type: integer }
                      referenceId: { type: string }
      responses:
        '200':
          description: Bulk token batch.
          content:
            application/json:
              schema:
                type: object
                properties:
                  batchId: { type: string }
                  tokens:
                    type: array
                    items:
                      type: object
                      properties:
                        referenceId: { type: string }
                        payWithMobileToken: { type: string }
components:
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer