tink-com/openapi/tink-connector-api-openapi.yml at main · api-evangelist/tink-com · 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
openapi: 3.1.0
info:
  title: Tink Connector API
  description: >
    Tink Connector lets partners push their own account and transaction data
    into the Tink platform for users they already authenticate, so those
    feeds benefit from Tink categorisation, recurring detection, Money
    Manager, and risk reporting alongside PSD2-aggregated data.
  version: '1.0'
  contact:
    name: Tink Developer Support
    url: https://docs.tink.com/resources/connector
servers:
  - url: https://api.tink.com
    description: Tink EU Production
security:
  - BearerAuth: []
tags:
  - name: ConnectorAccounts
    description: Partner-ingested accounts.
  - name: ConnectorTransactions
    description: Partner-ingested transactions.
paths:
  /connector/users/{external_user_id}/accounts:
    post:
      summary: Tink Ingest Connector Accounts
      description: Push a batch of partner accounts for the specified Tink user.
      operationId: ingestConnectorAccounts
      tags:
        - ConnectorAccounts
      parameters:
        - $ref: '#/components/parameters/ExternalUserIdParam'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConnectorAccountBatch'
      responses:
        '202':
          description: Accounts accepted for ingestion.
  /connector/users/{external_user_id}/transactions:
    post:
      summary: Tink Ingest Connector Transactions
      description: Push a batch of partner transactions for the specified Tink user and accounts.
      operationId: ingestConnectorTransactions
      tags:
        - ConnectorTransactions
      parameters:
        - $ref: '#/components/parameters/ExternalUserIdParam'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConnectorTransactionBatch'
      responses:
        '202':
          description: Transactions accepted for ingestion.
components:
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
  parameters:
    ExternalUserIdParam:
      in: path
      name: external_user_id
      required: true
      schema:
        type: string
  schemas:
    ConnectorAccountBatch:
      type: object
      properties:
        accounts:
          type: array
          items:
            $ref: '#/components/schemas/ConnectorAccount'
    ConnectorAccount:
      type: object
      properties:
        externalAccountId:
          type: string
        name:
          type: string
        type:
          type: string
          enum: [CHECKING, SAVINGS, CREDIT_CARD, LOAN, INVESTMENT, OTHER]
        currencyCode:
          type: string
        balance:
          $ref: '#/components/schemas/Money'
        identifiers:
          type: object
          properties:
            iban:
              type: string
            sortCode:
              type: string
            accountNumber:
              type: string
    ConnectorTransactionBatch:
      type: object
      properties:
        transactions:
          type: array
          items:
            $ref: '#/components/schemas/ConnectorTransaction'
    ConnectorTransaction:
      type: object
      properties:
        externalTransactionId:
          type: string
        externalAccountId:
          type: string
        amount:
          $ref: '#/components/schemas/Money'
        bookedDate:
          type: string
          format: date
        description:
          type: string
        merchantName:
          type: string
    Money:
      type: object
      properties:
        amount:
          type: string
        currencyCode:
          type: string