td-bank/openapi/td-bank-notifications-api-openapi.yml at main · api-evangelist/td-bank · 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
openapi: 3.1.0
info:
  title: TD Bank Account Basic Accounts Notifications API
  description: FDX v6.2 Account Basic endpoint. Returns lightweight account information (accountId, type, displayName, masked number) for every consented TD account so aggregators can enumerate accounts without retrieving full detail.
  version: 1.0.0
  contact:
    name: TD Open Banking Developer Support
    url: https://developer.td.com
servers:
- url: https://api.openbanking.amcb.developer.td.com/fdx/v6
  description: Production
- url: https://api.openbanking.amcb.developer.td.com/sandbox/fdx/v6
  description: Sandbox
security:
- oauth2: []
tags:
- name: Notifications
paths:
  /notifications:
    get:
      operationId: listNotifications
      summary: List Notifications
      tags:
      - Notifications
      parameters:
      - name: category
        in: query
        required: false
        schema:
          type: string
          enum:
          - maintenance
          - consent_revoked
          - consent_changed
      - name: since
        in: query
        required: false
        schema:
          type: string
          format: date-time
      responses:
        '200':
          description: Notifications
          content:
            application/json:
              schema:
                type: object
                properties:
                  notifications:
                    type: array
                    items:
                      $ref: '#/components/schemas/Notification'
  /notifications/{notificationId}:
    get:
      operationId: getNotification
      summary: Get Notification
      tags:
      - Notifications
      parameters:
      - name: notificationId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Notification detail
components:
  schemas:
    Notification:
      type: object
      required:
      - notificationId
      - category
      properties:
        notificationId:
          type: string
        category:
          type: string
        severity:
          type: string
        title:
          type: string
        description:
          type: string
        affectedResources:
          type: array
          items:
            type: string
        consentId:
          type: string
        createdAt:
          type: string
          format: date-time
  securitySchemes:
    oauth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://api.openbanking.amcb.developer.td.com/oauth/v1/authorize
          tokenUrl: https://api.openbanking.amcb.developer.td.com/oauth/v1/token
          scopes:
            accounts_basic_read: Read basic account info
externalDocs:
  description: TD Open Banking — About Our APIs
  url: https://docs.pat.openbanking.amcb.developer.td.com/guides/about-our-apis-hdi