Tink API

https://docs.tink.com/api-
Admin
Tink API provides an open banking platform for developers to build financial services and...
Tokens:96,993
Snippets:446
Trust Score:10
Update:1 year ago
Show doc for...
Tokens:
Raw
### Get Account List Response Example

Source: https://docs.tink.com/api-/data-v1

Provides an example of the JSON response when retrieving a list of accounts. This includes account details such as balance, currency, and identifiers.

```json
{
  "accounts": [
    {
      "accountExclusion": "AGGREGATION",
      "accountNumber": "1234-123456789",
      "balance": 34567.5,
      "bankId": "DE239857295893485",
      "closed": false,
      "credentialsId": "6e68cc6287704273984567b3300c5822",
      "currencyDenominatedBalance": {
        "currencyCode": "EUR",
        "scale": 2,
        "unscaledValue": 1050
      },
      "details": {
        "interest": 0,
        "nextDayOfTermsChange": "string",
        "numMonthsBound": 0,
        "type": "MORTGAGE"
      },
      "excluded": false,
      "favored": false,
      "financialInstitutionId": "6e68cc6287704273984567b3300c5822",
      "firstSeen": 1455009102000,
      "flags": "[\"MANDATE\"]",
      "holderName": "Thomas Alan Waits",
      "iban": "SE7921000813610123456789",
      "id": "a6bb87e57a8c4dd4874b241471a2b9e8",
      "identifiers": "[\"se://9999111111111111\"]",
      "name": "My account",
      "ownership": 0.5,
      "refreshed": 1455740874875,
      "type": "CHECKING"
    }
  ]
}
```

--------------------------------

### Get Account Balances Response Example

Source: https://docs.tink.com/api-/data-v1

This JSON object represents an example response from the GET /api/v1/accounts/{id}/balances endpoint, detailing an account's available, booked, and credit limit balances.

```json
{
  "accountId": "a6bb87e57a8c4dd4874b241471a2b9e8",
  "balances": {
    "available": {
      "currencyCode": "EUR",
      "scale": 2,
      "unscaledValue": 1050
    },
    "booked": {
      "currencyCode": "EUR",
      "scale": 2,
      "unscaledValue": 1050
    },
    "creditLimit": {
      "currencyCode": "EUR",
      "scale": 2,
      "unscaledValue": 1050
    }
  },
  "refreshed": 1455740874875
}
```

--------------------------------

### Get Consent Response Example

Source: https://docs.tink.com/api-/connectivity-v2

Provides an example of a successful response when fetching consent details from the Tink API. It includes information about the consent, associated financial services, and user parameters.

```json
{
  "consent": {
    "appId": "afae2e2a57b64009aa94f593d012b869",
    "authorizedAt": "2022-11-28T08:45:33.408Z",
    "createdAt": "2022-11-28T08:35:33.408Z",
    "expiresAt": "2022-12-28T08:35:33.408Z",
    "financialService": {
      "subtype": "VRP_SWEEPING",
      "type": "MANDATE_PAYMENTS"
    },
    "financialServiceParameters": {
      "userParameters": {
        "controlParameters": {
          "maximumIndividualAmount": {
            "currency": "GBP",
            "value": {
              "scale": 2,
              "unscaledValue": 199
            }
          },
          "periodicLimits": [
            {
              "amount": {
                "currency": "GBP",
                "value": {
                  "scale": 2,
                  "unscaledValue": 299
                }
              },
              "periodAlignment": "MANDATE",
              "periodType": "DAY"
            },
            {
              "amount": {
                "currency": "GBP",
                "value": {
                  "scale": 2,
                  "unscaledValue": 999
                }
              },
              "periodAlignment": "MANDATE",
              "periodType": "MONTH"
            }
          ],
          "validFrom": "2022-07-25T10:10:38.850Z",
          "validTo": "2022-12-25T10:10:38.850Z"
        },
        "merchantId": "9a1e5197-33ad-4f17-8338-0861a69ed1d0",
        "payeeAccount": {
          "name": "Tom John Savings Account",
          "number": "10000031510604",
          "type": "SORT_CODE"
        },
        "payerAccount": {
          "holderName": "Tom John",
          "number": "60092067037135",
          "type": "SORT_CODE"
        }
      },
      "version": "1.0.0"
    },
    "id": "c63dc11e-b210-4a96-9461-2061389789e7",
    "providerId": "se-nordea-ob",
    "revokedAt": "2022-12-24T08:35:33.408Z",
    "state": "INITIALIZED",
    "userId": "7c41103806a011edb9390242ac120002"
  }
}
```

--------------------------------

### Account Balance Response Example

Source: https://docs.tink.com/api-/data-v2

An example JSON response for the 'Get Account Balances' endpoint. It illustrates the structure of account balance details, including account ID, different balance types (available, booked), credit limit, and currency information.

```JSON
{
  "accountId": "a6bb87e57a8c4dd4874b241471a2b9e8",
  "balances": {
    "availableBalanceExcludingCredit": {
      "amount": {
        "currencyCode": "EUR",
        "value": {
          "scale": 2,
          "unscaledValue": 1050
        },
        "valueInMinorUnit": 1050
      }
    },
    "availableBalanceIncludingCredit": {
      "amount": {
        "currencyCode": "EUR",
        "value": {
          "scale": 2,
          "unscaledValue": 1050
        },
        "valueInMinorUnit": 1050
      }
    },
    "bookedBalance": {
      "amount": {
        "currencyCode": "EUR",
        "value": {
          "scale": 2,
          "unscaledValue": 1050
        },
        "valueInMinorUnit": 1050
      }
    }
  },
  "creditLimit": {
    "amount": {
      "currencyCode": "EUR",
      "value": {
        "scale": 2,
        "unscaledValue": 1050
      },
      "valueInMinorUnit": 1050
    }
  },
  "refreshed": "2022-09-27T15:01:40Z"
}
```

--------------------------------

### Account Response Example (JSON)

Source: https://docs.tink.com/api-/data-v2

Provides a sample JSON response for the 'Get Account' API call, illustrating the structure of account information including balances, identifiers, and dates.

```json
{
  "balances": {
    "booked": {
      "amount": {
        "currencyCode": "EUR",
        "value": {
          "scale": "-3",
          "unscaledValue": "19"
        }
      }
    }
  },
  "customerSegment": "UNDEFINED_CUSTOMER_SEGMENT",
  "dates": {
    "lastRefreshed": "2020-12-15T12:16:58Z"
  },
  "externalAccountId": "string",
  "financialInstitutionId": "6e68cc6287704273984567b3300c5822",
  "id": "ee7ddbd178494220bb184791783f4f63",
  "identifiers": {
    "financialInstitution": {
      "accountNumber": "SE6930000000011273547693"
    },
    "iban": {
      "bban": "0000011273547693",
      "iban": "SE6930000000011273547693"
    },
    "pan": {
      "masked": "4000 12** **** 9010"
    }
  },
  "name": "PERSONKONTO",
  "type": "CHECKING"
}
```

--------------------------------

### Get Budget Details Response Example

Source: https://docs.tink.com/api-/finance-management

Example JSON response for retrieving budget details. It includes the budget specification, average spent amount, total spent amount, and a list of budget periods with their start and end dates.

```json
{
  "averageSpentAmount": {
    "currencyCode": "EUR",
    "scale": 2,
    "unscaledValue": 1050
  },
  "budgetPeriods": [
    {
      "end": 1549976786000,
      "spentAmount": {
        "currencyCode": "EUR",
        "scale": 2,
        "unscaledValue": 1050
      },
      "start": 1549976786000
    }
  ],
  "budgetSpecification": {
    "amount": {
      "currencyCode": "EUR",
      "scale": 2,
      "unscaledValue": 1050
    },
    "archived": true,
    "created": 1552395986000,
    "filter": {
      "accounts": [
        {
          "id": "fe34e15244334995bd227e380fcb82fa"
        }
      ],
      "categories": [
        {
          "code": "01f944531ab04cd3ba32a14cebe8a927"
        }
      ],
      "freeTextQuery": "Monmouth Coffee",
      "tags": [
        {
          "key": "coffee"
        }
      ]
    },
    "id": "e2b746ed27c542ce846a8d693474df21",
    "name": "Coffee budget",
    "oneOffPeriodicity": {
      "end": 1549976786000,
      "start": 1552395986000
    },
    "periodicityType": "ONE_OFF",
    "recurringPeriodicity": {
      "periodUnit": "WEEK"
    }
  },
  "end": 1549976786000,
  "start": 1549976786000,
  "totalSpentAmount": {
    "currencyCode": "EUR",
    "scale": 2,
    "unscaledValue": 1050
  }
}
```

--------------------------------

### Subscription Response Example

Source: https://docs.tink.com/api-/finance-management

An example JSON response for listing user subscriptions, featuring pagination tokens and an array of subscription objects with detailed financial information.

```json
{
  "nextPageToken": "MQ==",
  "subscriptions": [
    {
      "accountId": "d9f134ee2eb44846a4e02990ecc8d32e",
      "brand": {
        "contact": {
          "website": "string"
        },
        "id": "string",
        "logoUrl": "string",
        "name": "string"
      },
      "categoryId": "d9f134ee2eb44846a4e02990ecc8d32e",
      "description": "Netflix",
      "startDate": "2024-07-01",
      "subscriptionCost": {
        "currencyCode": "EUR",
        "value": {
          "scale": 2,
          "unscaledValue": 1050
        }
      },
      "subscriptionId": "d9f134ee2eb44846a4e02990ecc8d32e",
      "totalSubscriptionSpend": {
        "currencyCode": "EUR",
        "value": {
          "scale": 2,
          "unscaledValue": 1050
        }
      }
    }
  ]
}
```

--------------------------------

### List Authorizations Response Example

Source: https://docs.tink.com/api-/connectivity-v2

An example JSON response for the 'List authorizationsBeta' endpoint, showing the structure of the returned authorizations array and the nextPageToken.

```json
{
  "authorizations": [
    {
      "appUri": "string",
      "callbackUri": "string",
      "canceledAt": "2022-11-28T08:42:33.408Z",
      "consentId": "c63dc11e-b210-4a96-9461-2061389789e7",
      "createdAt": "2022-11-28T08:42:33.408Z",
      "detailedError": {
        "details": {
          "reason": "STATIC_CREDENTIALS_INCORRECT"
        },
        "displayMessage": "The bank rejected the login credentials that you entered.",
        "type": "USER_LOGIN_ERROR"
      },
      "failedAt": "2022-11-28T08:42:33.408Z",
      "id": "c63dc11e-b210-4a96-9461-2061389789e7",
      "originatingUserIp": "198.51.100.10",
      "revokedAt": "2022-11-28T08:42:33.408Z",
      "state": "ONGOING",
      "succeededAt": "2022-11-28T08:45:33.408Z",
      "supplementalInformation": {
        "id": "c63dc11e-b210-4a96-9461-2061389789e7",
        "redirectUri": "https://financial-service.com/authorize-here?id=1a5b3x9s16s"
      }
    }
  ],
  "nextPageToken": "ZDU0N2M0YTVkZTk3NGIxODkxMjNmZWVmYzEwNjQxZDg="
}
```

--------------------------------

### Create One-Off Budget Request Example

Source: https://docs.tink.com/api-/finance-management

Example JSON payload for creating a one-off budget. It includes the budget name, target amount, filtering criteria (accounts, categories, free text, tags), and the specific start and end dates for the budget period.

```json
{
  "amount": {
    "currencyCode": "EUR",
    "scale": 2,
    "unscaledValue": 1050
  },
  "filter": {
    "accounts": [
      {
        "id": "fe34e15244334995bd227e380fcb82fa"
      }
    ],
    "categories": [
      {
        "code": "01f944531ab04cd3ba32a14cebe8a927"
      }
    ],
    "freeTextQuery": "Monmouth Coffee",
    "tags": [
      {
        "key": "coffee"
      }
    ]
  },
  "name": "Coffee budget",
  "oneOffPeriodicity": {
    "end": 1549976786000,
    "start": 1552395986000
  }
}
```

--------------------------------

### Loan Response Example

Source: https://docs.tink.com/api-/data-v1

Provides an example of a successful response when querying for loan information. It details the structure of the 'loans' array, including account details, financial figures, and loan specifics.

```json
{
  "loans": [
    {
      "accountId": "a7b67265-8030-4d65-aa42-a8f4bd287a72",
      "amortized": 1000.0,
      "balance": -9000.0,
      "id": "65bc7a41-a66e-4ad1-aad1-99bbfb3c5098",
      "initialBalance": -10000.0,
      "initialDate": 1455740874875,
      "interest": 0.025,
      "loanDetails": {
        "accountId": "string",
        "applicants": [
          "string",
          "string"
        ],
        "coApplicant": false,
        "loanSecurity": "string"
      },
      "loanNumber": "01-123456-234567",
      "monthlyAmortization": 100.0,
      "name": "Car Loan",
      "nextDayOfTermsChange": 1455740874875,
      "numMonthsBound": 36,
      "providerName": "handelsbanken-bankid",
      "type": "MORTGAGE",
      "updated": 1553169600000,
      "userId": "53559ef7-4508-4048-b322-2b175cdaab23"
    }
  ],
  "totalLoanAmount": 0,
  "weightedAverageInterestRate": 0
}
```

--------------------------------

### Get Payment Request Example

Source: https://docs.tink.com/api-/payment

This snippet shows an example JSON response for a successful payment request retrieval. It includes details about the payment amount, currency, destination, recipient, sender, and remittance information.

```json
{
  "amount": 10,
  "currency": "GBP",
  "destinations": [
    {
      "accountNumber": "string",
      "type": "bban"
    }
  ],
  "executionDate": "2023-11-20",
  "id": "18408f41163f4748b87da9b9a68b6df8",
  "market": "GB",
  "merchantId": "c7f2de71-ad83-4eb7-b7df-5ed6445cb2af",
  "metadata": {
    "custom key": "custom value",
    "merchantReference": "17172137"
  },
  "paymentScheme": "DANISH_DOMESTIC_CREDIT_TRANSFER",
  "recipient": {
    "accountNumber": "string",
    "accountType": "bban",
    "address": {
      "city": "string",
      "countryCode": "string",
      "flatNumber": "string",
      "postCode": "string",
      "region": "string",
      "streetName": "string",
      "streetNumber": "string"
    },
    "businessIdentifierCode": "string"
  },
  "recipientName": "Test AB",
  "remittanceInformation": {
    "type": "UNSTRUCTURED",
    "value": "string"
  },
  "sender": {
    "accountNumber": "string",
    "accountType": "bban",
    "firstName": "string",
    "lastName": "string"
  },
  "sourceMessage": "Payment for Gym Equipment"
}
```

--------------------------------

### List Markets API Response

Source: https://docs.tink.com/api-/connectivity-v1

Example response for the GET /api/v1/providers/markets endpoint, listing available markets.

```json
{
  "markets": [
    "string",
    "string"
  ]
}
```

--------------------------------

### Get Budget Transactions Response Example

Source: https://docs.tink.com/api-/finance-management

Provides an example of a successful response when retrieving transactions for a specific budget. It includes transaction details such as account ID, amount, category, date, description, and pending status.

```json
{
  "transactions": [
    {
      "accountId": "325ee4ccf579450ca59d89ee54fa7e40",
      "amount": {
        "currencyCode": "EUR",
        "scale": 2,
        "unscaledValue": 1050
      },
      "categoryCode": "expenses:food.coffee",
      "date": 1549976786000,
      "description": "Monmouth Coffee Company",
      "dispensableAmount": {
        "currencyCode": "EUR",
        "scale": 2,
        "unscaledValue": 1050
      },
      "id": "e2b746ed27c542ce846a8d693474df21",
      "pending": true
    }
  ]
}
```

--------------------------------

### Example Response: ListCalendarSummariesResponse

Source: https://docs.tink.com/api-/finance-management

An example of the JSON response when listing financial calendar summaries. It includes details about the number of events and the period they cover.

```JSON
{
  "summaries": [
    {
      "numberOfEvents": 10,
      "numberOfEventsCompletedNotReconciledPastDueDate": 5,
      "numberOfEventsNotCompletedPastDueDate": 5,
      "numberOfEventsRequiringActionLater": 0,
      "numberOfEventsRequiringCriticalAction": 0,
      "numberOfEventsRequiringNoAction": 0,
      "numberOfEventsRequiringUrgentAction": 0,
      "period": {
        "end": "2020-07-05T23:59:59.999999999Z",
        "identity": "2020-W27",
        "resolution": "WEEKLY",
        "start": "2020-06-29T00:00:00Z"
      }
    }
  ]
}
```

--------------------------------

### Create Authorization Grant Response Example

Source: https://docs.tink.com/api-/general

Example JSON response containing the authorization code.

```json
{
  "code": "c50cd6960a6f44ffb701ef60fafa7761"
}
```

--------------------------------

### Deposit Funds to Savings Goal Response Example

Source: https://docs.tink.com/api-/finance-management

This is an example of a successful response when depositing funds to a Savings Goal. It includes details about the deposited amount, creation time, and destination.

```json
{
  "amount": {
    "currencyCode": "EUR",
    "scale": 2,
    "unscaledValue": 2000
  },
  "createTime": "2020-05-14T13:30:45Z",
  "destinationId": "d9f134ee2eb44846a4e02990ecc8d32e",
  "destinationType": "SAVINGS_GOAL",
  "id": "d9f134ee2eb44846a4e02990ecc8d32e",
  "sourceId": "d9f134ee2eb44846a4e02990ecc8d32e",
  "sourceType": "string"
}
```

--------------------------------

### Account Verification Response Example

Source: https://docs.tink.com/api-/data-v1

This is an example JSON response for an account verification report. It contains details about the created report, external references, user data by provider, and financial institution information.

```json
{
  "created": 1455740874875,
  "externalReference": "ext-abc-123",
  "id": "6e68cc6287704273984567b3300c5822",
  "userDataByProvider": [
    {
      "accounts": [
        {
          "accountIdentifiers": {
            "ach": {
              "accountNumber": "0123456789",
              "routingNumber": "021000021",
              "wireRoutingNumber": "021000021"
            },
            "bacs": {
              "accountNumber": "12345678",
              "sortCode": "601314"
            },
            "iban": {
              "bban": "21000813610123456789",
              "bic": "DABASESX",
              "iban": "SE7921000813610123456789"
            },
            "rix": {
              "accountNumber": "8257466",
              "clearingNumber": "5839"
            }
          },
          "accountNumber": "1234-123456789",
          "accountType": "SAVINGS",
          "commercialName": "Commercial name",
          "currencyCode": "EUR",
          "customerSegment": "PERSONAL",
          "holderName": "John Doe",
          "iban": "SE7921000813610123456789",
          "id": "a6bb87e57a8c4dd4874b241471a2b9e8",
          "name": "John's account",
          "nameMatching": {
            "matchingResult": "EXACT_MATCH",
            "name": "John Doe"
          },
          "parties": [
            {
              "identity": {
                "name": "John Doe",
                "ssn": "19670220-1234"
              },
              "role": "HOLDER"
            }
          ]
        }
      ],
      "financialInstitutionName": "Bank Name",
      "identity": {
        "addresses": [
          {
            "city": "London",
            "countryCode": "US",
            "postalCode": "11155",
            "street": "1600 Pennsylvania Avenue NW",
            "subdivision": "Ohio",
            "type": "PO_BOX"
          }
        ],
        "dateOfBirth": "1967-02-20",
        "emails": [
          {
            "address": "test@example.com",
            "type": "PRIMARY"
          }
        ],
        "name": "John Doe",
        "phoneNumbers": [
          {
            "number": "+1 206 555 0100",
            "type": "PRIMARY"
          }
        ],
        "ssn": "19670220-1234"
      },
      "providerName": "se-bank-oauth",
      "updated": 1455740124123
    }
  ]
}
```

--------------------------------

### Link Transactions Response Example

Source: https://docs.tink.com/api-/data-v1

A detailed JSON example of a successful response when linking transactions. It includes information about both the counterpart transaction and the primary transaction.

```json
{
  "counterpartTransaction": {
    "accountId": "3fe2d96efacd4dc5994404a950f238a9",
    "amount": 34.5,
    "categoryId": "0e1bade6a7e3459eb794f27b7ba4cea0",
    "categoryType": "EXPENSES",
    "credentialsId": "65bc7a41a66e4ad1aad199bbfb3c5098",
    "currencyDenominatedAmount": {
      "currencyCode": "EUR",
      "scale": 2,
      "unscaledValue": 1050
    },
    "currencyDenominatedOriginalAmount": {
      "currencyCode": "EUR",
      "scale": 2,
      "unscaledValue": 1050
    },
    "date": 1455740874875,
    "description": "Stadium Sergelg Stockholm",
    "dispensableAmount": 0,
    "formattedDescription": "Stadium Sergelgatan Stockholm",
    "id": "79c6c9c27d6e42489e888e08d27205a1",
    "identifiers": {
      "providerExternalId": "600aca79-23f2-4476-ac3a-5f1893b3b844"
    },
    "inserted": 1455740874875,
    "lastModified": 1455740874875,
    "notes": "Delicious #cake #wedding",
    "originalAmount": 34.5,
    "originalDate": 1455740874875,
    "originalDescription": "Stadium Sergelg Stockholm",
    "partnerPayload": {},
    "parts": [
      {
        "amount": 34.5,
        "categoryId": "0e1bade6a7e3459eb794f27b7ba4cea0",
        "counterpartDescription": "Stadium Sergelg Stockholm",
        "counterpartId": "79c6c9c27d6e42489e888e08d27205a1",
        "counterpartTransactionAmount": 10.0,
        "counterpartTransactionId": "d030a7b0840547428aa2fd07026e9a77",
        "date": 1455740874875,
        "id": "7303ff128531463bbed358bbf9e23f31",
        "lastModified": 1455740874875
      }
    ],
    "payload": {},
    "pending": false,
    "timestamp": 1464543093494,
    "type": "CREDIT_CARD",
    "upcoming": false,
    "userId": "d9f134ee2eb44846a4e02990ecc8d32e",
    "userModified": false
  },
  "transaction": {
    "accountId": "3fe2d96efacd4dc5994404a950f238a9",
    "amount": 34.5,
    "categoryId": "0e1bade6a7e3459eb794f27b7ba4cea0",
    "categoryType": "EXPENSES",
    "credentialsId": "65bc7a41a66e4ad1aad199bbfb3c5098",
    "currencyDenominatedAmount": {
      "currencyCode": "EUR",
      "scale": 2,
      "unscaledValue": 1050
    },
    "currencyDenominatedOriginalAmount": {
      "currencyCode": "EUR",
      "scale": 2,
      "unscaledValue": 1050
    },
    "date": 1455740874875,
    "description": "Stadium Sergelg Stockholm",
    "dispensableAmount": 0,
    "formattedDescription": "Stadium Sergelgatan Stockholm",
    "id": "79c6c9c27d6e42489e888e08d27205a1",
    "identifiers": {
      "providerExternalId": "600aca79-23f2-4476-ac3a-5f1893b3b844"
    },
    "inserted": 1455740874875,
    "lastModified": 1455740874875,
    "notes": "Delicious #cake #wedding",
    "originalAmount": 34.5,
    "originalDate": 1455740874875,
    "originalDescription": "Stadium Sergelg Stockholm",
    "partnerPayload": {},
    "parts": [
      {
        "amount": 34.5,
        "categoryId": "0e1bade6a7e3459eb794f27b7ba4cea0",
        "counterpartDescription": "Stadium Sergelg Stockholm",
        "counterpartId": "79c6c9c27d6e42489e888e08d27205a1",
        "counterpartTransactionAmount": 10.0,
        "counterpartTransactionId": "d030a7b0840547428aa2fd07026e9a77",
        "date": 1455740874875,
        "id": "7303ff128531463bbed358bbf9e23f31",
        "lastModified": 1455740874875
      }
    ],
    "payload": {},
    "pending": false,
    "timestamp": 1464543093494,
    "type": "CREDIT_CARD",
    "upcoming": false,
    "userId": "d9f134ee2eb44846a4e02990ecc8d32e",
    "userModified": false
  }
}
```

--------------------------------

### List Period Progress Response Example

Source: https://docs.tink.com/api-/finance-management

Example JSON response for the List Period Progress API endpoint, detailing pagination information and a list of period progress objects.

```json
{
  "nextPageToken": "string",
  "periodProgresses": [
    {
      "amountSavedThisPeriod": {
        "currencyCode": "EUR",
        "scale": 2,
        "unscaledValue": 2000
      },
      "periodEndDate": "2020-02-25",
      "periodStartDate": "2020-01-25",
      "reachedAmountForSavingsGoalThisPeriod": {
        "currencyCode": "EUR",
        "scale": 2,
        "unscaledValue": 2000
      }
    }
  ]
}
```

--------------------------------

### List Categories Response Example

Source: https://docs.tink.com/api-/finance-management

Example JSON response for the List Categories API endpoint, showing an array of available savings goal categories.

```json
{
  "categories": [
    "string",
    "string"
  ]
}
```

--------------------------------

### List Settlement Accounts Response Example

Source: https://docs.tink.com/api-/payment

An example JSON response for the 'List Settlement Accounts' endpoint, illustrating the structure of settlement accounts, pagination tokens, and total size.

```JSON
{
  "accounts": [
    {
      "accountIdentifier": {
        "identifier": "00000012345678",
        "type": "SORT_CODE"
      },
      "appId": "",
      "availableBalance": {
        "currencyCode": "GBP",
        "value": {
          "scale": "2",
          "unscaledValue": "271100"
        }
      },
      "balance": {
        "currencyCode": "GBP",
        "value": {
          "scale": "2",
          "unscaledValue": "276400"
        }
      },
      "countryCode": "GB",
      "currencyCode": "GBP",
      "id": "744cf927-29cd-475e-9ef2-2b11951d3cc9",
      "merchantId": "2c9ba5fd-cbdb-4ed5-84a4-01db5698f0d9",
      "name": "Account name",
      "payoutAccount": {
        "currencyCode": "GBP",
        "frequency": "MONTHLY",
        "identifier": {
          "identifier": "00000070438943",
          "type": "SORT_CODE"
        }
      },
      "reservedAmount": {
        "scale": "1",
        "unscaledValue": "100"
      },
      "status": "ENABLED",
      "type": "APP_ACCOUNT"
    }
  ],
  "nextPageToken": "MA=",
  "prevPageToken": "MA==",
  "totalSize": "1"
}
```

--------------------------------

### Cancellation Response Example

Source: https://docs.tink.com/api-/payment

An example JSON response for a payment cancellation request. It includes the status of the cancellation and a Tink Link for authentication if needed.

```json
{
  "status": "AWAITING_AUTHENTICATION",
  "tinkLink": "https://link.tink.com/1.0/pay/cancellation?client_id=123&market=SE&authorization_code=123456&credentials_id=ccc1e79ff30f4865a54604754a72e380&payment_request_id=dada49e225064bbeafcb78cb7dba59a4"
}
```

--------------------------------

### Create Settlement Account Payment Request Example

Source: https://docs.tink.com/api-/payment

Example JSON payload for creating a settlement account payment request. It includes amount details, metadata, reference, and scheme.

```JSON
{
  "amount": {
    "currencyCode": "EUR",
    "value": {
      "scale": "2",
      "unscaledValue": "5000"
    }
  },
  "metadata": {
    "key1": "value1",
    "key2": "value2"
  },
  "reference": "Refund7ad0feabb4ab",
  "scheme": "SEPA_INSTANT_CREDIT_TRANSFER",
  "transactionId": "7ad0feab-bd55-449d-aa7e-b3d3b9c62550"
}
```

--------------------------------

### Reallocate Response Example

Source: https://docs.tink.com/api-/finance-management

Example JSON response for the ReAllocate API endpoint, confirming a successful fund reallocation and providing transaction details.

```json
{
  "amount": {
    "currencyCode": "EUR",
    "scale": 2,
    "unscaledValue": 2000
  },
  "createTime": "2020-05-14T13:30:45Z",
  "destinationId": "d9f134ee2eb44846a4e02990ecc8d32e",
  "destinationType": "SAVINGS_GOAL",
  "id": "d9f134ee2eb44846a4e02990ecc8d32e",
  "sourceId": "d9f134ee2eb44846a4e02990ecc8d32e",
  "sourceType": "string"
}
```

--------------------------------

### Budget Response Example

Source: https://docs.tink.com/api-/finance-management

Example JSON response for a budget, showcasing its structure including amount, filter criteria (accounts, categories, free text, tags), periodicity, and other metadata.

```json
{
  "amount": {
    "currencyCode": "EUR",
    "scale": 2,
    "unscaledValue": 1050
  },
  "archived": true,
  "created": 1552395986000,
  "filter": {
    "accounts": [
      {
        "id": "fe34e15244334995bd227e380fcb82fa"
      }
    ],
    "categories": [
      {
        "code": "01f944531ab04cd3ba32a14cebe8a927"
      }
    ],
    "freeTextQuery": "Monmouth Coffee",
    "tags": [
      {
        "key": "coffee"
      }
    ]
  },
  "id": "e2b746ed27c542ce846a8d693474df21",
  "name": "Coffee budget",
  "oneOffPeriodicity": {
    "end": 1549976786000,
    "start": 1552395986000
  },
  "periodicityType": "ONE_OFF",
  "recurringPeriodicity": {
    "periodUnit": "WEEK"
  }
}
```

--------------------------------

### Savings Goal Response Example

Source: https://docs.tink.com/api-/finance-management

An example JSON response for a Savings Goal, illustrating the structure and data fields including account, categories, dates, amounts, and status.

```json
{
  "account": "d9f134ee2eb44846a4e02990ecc8d32e",
  "categories": [
    "wedding",
    "trip"
  ],
  "createTime": "2020-05-14T13:30:45Z",
  "description": "The savings goal for our big wedding. Including wedding-singers.",
  "id": "d9f134ee2eb44846a4e02990ecc8d32e",
  "name": "Wedding",
  "oneOffPeriodicity": {
    "targetAmount": {
      "currencyCode": "EUR",
      "scale": 2,
      "unscaledValue": 2000
    },
    "targetDate": "2022-10-25"
  },
  "periodicityType": "ONE_OFF",
  "recurringPeriodicity": {
    "periodSavedAmount": {
      "currencyCode": "EUR",
      "scale": 2,
      "unscaledValue": 2000
    },
    "periodTargetAmount": {
      "currencyCode": "EUR",
      "scale": 2,
      "unscaledValue": 2000
    },
    "periodUnit": "WEEK",
    "totalTargetAmount": {
      "currencyCode": "EUR",
      "scale": 2,
      "unscaledValue": 2000
    }
  },
  "savedAmount": {
    "currencyCode": "EUR",
    "scale": 2,
    "unscaledValue": 2000
  },
  "savingsPurpose": "[\"Investments\",\"Housing\"]",
  "status": "CREATED",
  "tags": [
    "icon:blue",
    "priority:10"
  ]
}
```

--------------------------------

### StatisticQuery Request Body Example

Source: https://docs.tink.com/api-/finance-management

An example of the JSON payload for a statistic query, specifying parameters like account ID, description, period, and resolution.

```json
[
  {
    "description": "fe9e199c2ca94c12baf1f3eb4a4122de",
    "payload": "690667930d7e4f2ba0d9aa5f7d2a1941",
    "period": "2014-12-15",
    "resolution": "DAILY",
    "type": "expenses-by-category",
    "userId": "d9f134ee2eb44846a4e02990ecc8d32e",
    "value": -1298.5
  }
]

```

--------------------------------

### Query Statistics Endpoint

Source: https://docs.tink.com/api-/finance-management

This example demonstrates how to query statistics using the /api/v1/statistics/query endpoint. It shows how to specify filters for type, period, and resolution, and includes an example of filtering by tags.

```json
POST /api/v1/statistics/query

Request Body Example:
{
  "filter": {
    "type": "some_statistic_type",
    "period": "2023-10",
    "resolution": "MONTHLY"
  },
  "tags": ["Cinema", "Theater"]
}
```

--------------------------------

### Create Credentials Response Example

Source: https://docs.tink.com/api-/connectivity-v1

This JSON object shows an example response after successfully creating credentials. It includes the credential ID, provider name, status, and other relevant details about the created credentials.

```json
{
  "fields": {
    "username": "198401011111"
  },
  "id": "6e68cc6287704273984567b3300c5822",
  "providerName": "handelsbanken-bankid",
  "sessionExpiryDate": 1493379467000,
  "status": "UPDATED",
  "statusPayload": "Analyzed 1,200 out of 1,200 transactions.",
  "statusUpdated": 1493379467000,
  "supplementalInformation": null,
  "type": "MOBILE_BANKID",
  "updated": 1493379467000,
  "userId": "c4ae034f96c740da91ae00022ddcac4d"
}
```

--------------------------------

### AccountParties Response Example

Source: https://docs.tink.com/api-/data-v2

Example JSON response for the Get Account Parties endpoint, showing the structure of parties with identity and role.

```JSON
{
  "parties": [
    {
      "identity": {
        "name": "John Doe",
        "ssn": "19670220-1234"
      },
      "role": "HOLDER"
    }
  ]
}
```

--------------------------------

### Provider Authentication Options Response Example

Source: https://docs.tink.com/api-/connectivity-v1

An example JSON response for the 'List authentication options for given market' API endpoint. It demonstrates the structure of the response, including provider details, authentication option groups, and individual authentication options with their respective fields and supported channels.

```json
{
  "providers": [
    {
      "authenticationOptionsGroups": [
        {
          "authenticationOptions": [
            {
              "default": false,
              "displayText": "Open Mobile Bank ID app in another device.",
              "fields": [],
              "helpText": "Indicates the user wants to open use the Mobile Bank ID application in another device.",
              "name": "SE_MOBILE_BANKID_OTHER_DEVICE",
              "supportedChannels": [
                "SUPPORTED_CHANNEL_MOBILE",
                "SUPPORTED_CHANNEL_DESKTOP"
              ]
            },
            {
              "default": true,
              "displayText": "Open Mobile Bank ID app.",
              "fields": [
                {
                  "description": "Social security number",
                  "hint": "YYYYMMDDNNNN",
                  "immutable": true,
                  "maxLength": 12,
                  "minLength": 12,
                  "name": "username",
                  "numeric": true,
                  "pattern": "^(?:(?:(?:(?:19|20)(?:0[48]|[2468][048]|[13579][26]))|2000)0229|(?:(?:19|20)[0-9]{2}(?:(?:(?:0[13578]|1[02])(?:[123]0|[012][1-9]|31))|(?:(?:0[469]|11)(?:[123]0|[012][1-9]))|02(?:[12]0|[012][1-8]|[01]9))))[0-9]{4}$",
                  "patternError": "Please enter a valid social security number."
                }
              ],
              "helpText": "Indicates the user wants to use the Mobile Bank ID application in their current device.",
              "name": "SE_MOBILE_BANKID_SAME_DEVICE",
              "supportedChannels": [
                "SUPPORTED_CHANNEL_MOBILE"
              ]
            }
          ],
          "displayText": "Choose where do you want to authenticate.",
          "helpText": "Used to specify in which device the user wants to open their Mobile Bank ID app.",
          "name": "SE_MOBILE_BANKID_DEVICE_CHOICE"
        }
      ],
      "providerName": "se-swedbank-ob"
    }
  ]
}
```

--------------------------------

### Get Reconciliations Details Response Example

Source: https://docs.tink.com/api-/finance-management

An example response for the 'Get reconciliations(links) details' endpoint, showing the reconciliation amount and a list of associated transaction IDs.

```json
{
  "reconciliationAmount": {
    "currencyCode": "EUR",
    "value": {
      "scale": "2",
      "unscaledValue": "1500"
    }
  },
  "reconciliations": [
    {
      "transactionId": "3c8067f4d8084e9687f7f9722e7909eb"
    }
  ]
}
```
Tokens:
Raw