{"_id":"5939d6e6c78839000f4c0033","project":"54c935c60174630d00efa949","version":"5939d621c78839000f4c0030","category":"5939d6c6c78839000f4c0032","user":"54c933e34574700d00f016f4","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-06-08T22:59:50.326Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":0,"body":"Our developer API provides access to banking related information for an account. We provide transaction data, balances, and other pieces of information and utilities. We're constantly iterating and adding new features, so check back soon!\n[block:api-header]\n{\n  \"title\": \"Clients\"\n}\n[/block]\n\nIn addition to the RESTful API, we provide clients to access the API in the following languages:\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"Go\",\n    \"h-0\": \"Language\",\n    \"h-1\": \"Client\",\n    \"0-1\": \"[seed-go](https://github.com/seedco/seed-go)\",\n    \"h-2\": \"Link\"\n  },\n  \"cols\": 2,\n  \"rows\": 1\n}\n[/block]","excerpt":"","slug":"general-overview","type":"basic","title":"General Overview","__v":0,"parentDoc":null,"childrenPages":[]}

General Overview


Our developer API provides access to banking related information for an account. We provide transaction data, balances, and other pieces of information and utilities. We're constantly iterating and adding new features, so check back soon! [block:api-header] { "title": "Clients" } [/block] In addition to the RESTful API, we provide clients to access the API in the following languages: [block:parameters] { "data": { "0-0": "Go", "h-0": "Language", "h-1": "Client", "0-1": "[seed-go](https://github.com/seedco/seed-go)", "h-2": "Link" }, "cols": 2, "rows": 1 } [/block]
Our developer API provides access to banking related information for an account. We provide transaction data, balances, and other pieces of information and utilities. We're constantly iterating and adding new features, so check back soon! [block:api-header] { "title": "Clients" } [/block] In addition to the RESTful API, we provide clients to access the API in the following languages: [block:parameters] { "data": { "0-0": "Go", "h-0": "Language", "h-1": "Client", "0-1": "[seed-go](https://github.com/seedco/seed-go)", "h-2": "Link" }, "cols": 2, "rows": 1 } [/block]
{"_id":"599a4a5d877d9c000f2ab66b","project":"54c935c60174630d00efa949","version":"5939d621c78839000f4c0030","category":"599a36b4fe9056000fcc9c24","user":"54c933e34574700d00f016f4","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-08-21T02:50:05.424Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[],"url":"","examples":{"codes":[]}},"isReference":false,"order":0,"body":"The API is versioned, which allows backwards-incompatible changes to be released without breaking API consumers.\n\nThere are two ways to request a particular API version:\n 1. Send a `Client-Version-Id` header with your versioning ID\n    - This is sent on every request, and is the recommended versioning method.\n 2. Send an `Api-Version` header\n    - The primary purpose is to temporarily override the `Client-Version-ID` and request a particular API version.\n    - This is useful for debugging and testing of newer API versions. For normal requests, a `Client-Version-Id` header should be used.","excerpt":"","slug":"overview","type":"basic","title":"Overview","__v":2,"parentDoc":null,"childrenPages":[]}

Overview


The API is versioned, which allows backwards-incompatible changes to be released without breaking API consumers. There are two ways to request a particular API version: 1. Send a `Client-Version-Id` header with your versioning ID - This is sent on every request, and is the recommended versioning method. 2. Send an `Api-Version` header - The primary purpose is to temporarily override the `Client-Version-ID` and request a particular API version. - This is useful for debugging and testing of newer API versions. For normal requests, a `Client-Version-Id` header should be used.
The API is versioned, which allows backwards-incompatible changes to be released without breaking API consumers. There are two ways to request a particular API version: 1. Send a `Client-Version-Id` header with your versioning ID - This is sent on every request, and is the recommended versioning method. 2. Send an `Api-Version` header - The primary purpose is to temporarily override the `Client-Version-ID` and request a particular API version. - This is useful for debugging and testing of newer API versions. For normal requests, a `Client-Version-Id` header should be used.
{"_id":"599a51800d43fa000fae554c","project":"54c935c60174630d00efa949","version":"5939d621c78839000f4c0030","category":"599a36b4fe9056000fcc9c24","user":"54c933e34574700d00f016f4","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-08-21T03:20:32.483Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[{"_id":"599a51940d43fa000fae554d","ref":"","in":"header","required":false,"desc":"A unique identifier associated with a particular version of the API. Sent on every request to indicate the desired API version.","default":"","type":"string","name":"Client-Version-Id"},{"_id":"599a52160d43fa000fae554e","ref":"","in":"header","required":false,"desc":"An override header used to request a particular version of the API.","default":"","type":"string","name":"Api-Version"}],"url":"/*","examples":{"codes":[]}},"isReference":false,"order":1,"body":"[block:api-header]\n{\n  \"title\": \"Client Version ID\"\n}\n[/block]\nThe client version ID is a unique identifier that is associated with a particular version of the API.\n\nThe ID is set in the `Client-Version-Id` header and is sent to the API on every request. It determines the version of the API that is served.\n\nWhen the client version ID is first generated, it is pinned to the current latest API version. All subsequent requests sent with the ID will request that particular version, and the version stays fixed until you decide to change it.\n\nWhen a newer version of the API gets released, the version associated with the ID still does not change. In this way, your client will be unaffected by newer backwards-incompatible changes, until you decide that you're ready to upgrade versions.\n\nYou can adjust the version associated with the client version ID via an API call. This allows you to upgrade to a later version of the API whenever you are ready to do so, or even downgrade if an upgrade caused issues.\n[block:api-header]\n{\n  \"title\": \"API Version\"\n}\n[/block]\nThis header is used to request a particular API version, overriding the `Client-Version-Id` header.\n\nIt is useful for testing. For example, you can use it to request a newer API version than your client currently supports, to check if the client is compatible.","excerpt":"","slug":"headers","title":"Headers","__v":2,"parentDoc":null,"childrenPages":[]}

Headers


Headers

Client-Version-Id:
string
A unique identifier associated with a particular version of the API. Sent on every request to indicate the desired API version.
Api-Version:
string
An override header used to request a particular version of the API.
[block:api-header] { "title": "Client Version ID" } [/block] The client version ID is a unique identifier that is associated with a particular version of the API. The ID is set in the `Client-Version-Id` header and is sent to the API on every request. It determines the version of the API that is served. When the client version ID is first generated, it is pinned to the current latest API version. All subsequent requests sent with the ID will request that particular version, and the version stays fixed until you decide to change it. When a newer version of the API gets released, the version associated with the ID still does not change. In this way, your client will be unaffected by newer backwards-incompatible changes, until you decide that you're ready to upgrade versions. You can adjust the version associated with the client version ID via an API call. This allows you to upgrade to a later version of the API whenever you are ready to do so, or even downgrade if an upgrade caused issues. [block:api-header] { "title": "API Version" } [/block] This header is used to request a particular API version, overriding the `Client-Version-Id` header. It is useful for testing. For example, you can use it to request a newer API version than your client currently supports, to check if the client is compatible.

User Information

Try It Out

{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



[block:api-header] { "title": "Client Version ID" } [/block] The client version ID is a unique identifier that is associated with a particular version of the API. The ID is set in the `Client-Version-Id` header and is sent to the API on every request. It determines the version of the API that is served. When the client version ID is first generated, it is pinned to the current latest API version. All subsequent requests sent with the ID will request that particular version, and the version stays fixed until you decide to change it. When a newer version of the API gets released, the version associated with the ID still does not change. In this way, your client will be unaffected by newer backwards-incompatible changes, until you decide that you're ready to upgrade versions. You can adjust the version associated with the client version ID via an API call. This allows you to upgrade to a later version of the API whenever you are ready to do so, or even downgrade if an upgrade caused issues. [block:api-header] { "title": "API Version" } [/block] This header is used to request a particular API version, overriding the `Client-Version-Id` header. It is useful for testing. For example, you can use it to request a newer API version than your client currently supports, to check if the client is compatible.
{"_id":"599b3449a8175a0025027d95","project":"54c935c60174630d00efa949","version":"5939d621c78839000f4c0030","category":"599a36b4fe9056000fcc9c24","user":"54c933e34574700d00f016f4","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-08-21T19:28:09.672Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"method":"post","examples":{"codes":[{"language":"curl","code":"curl -X POST \\\n  https://localhost:14002/v1/public/api/client-version \\\n  -H 'authorization: Bearer 2.a.gxDCXy_JTcGPFYb8M6zVgg.coXKLXuO8JWzSZKZ0TaQGKZMyY8Pkk-vSX7RgimNubE.YyWuB6YlCiSp1jPQEyv71EDpZbFxCgsWTaxdcqNsExw'"}]},"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"errors\": [],\n  \"results\": [\n    {\n      \"api_version\": \"1.0.0\",\n      \"created_at\": null,\n      \"deleted_at\": null,\n      \"id\": \"api-OkglKyYGJw70/jP8AhzHOQ==\",\n      \"individual_id\": \"0e9fa8da-1fa7-46b8-8eaa-8fb4f0c15e8d\",\n      \"updated_at\": null\n    }\n  ]\n}","name":""},{"status":401,"language":"json","code":"{\n  \"errors\": [\n    {\n      \"message\": \"Unauthorized.\"\n    }\n  ],\n  \"results\": []\n}","name":""}]},"settings":"","auth":"required","params":[],"url":"/public/api/client-version"},"isReference":false,"order":2,"body":"This endpoint will generate and assign you with a client version ID. The ID is sent in each request to the API, and will request the API version associated with the client version ID.","excerpt":"Creates an ID used for controlling the requested API version.","slug":"create-client-version-id","type":"post","title":"Create Client Version ID","__v":0,"parentDoc":null,"childrenPages":[]}

postCreate Client Version ID

Creates an ID used for controlling the requested API version.

This endpoint will generate and assign you with a client version ID. The ID is sent in each request to the API, and will request the API version associated with the client version ID.

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



This endpoint will generate and assign you with a client version ID. The ID is sent in each request to the API, and will request the API version associated with the client version ID.
{"_id":"5939d705c78839000f4c0034","project":"54c935c60174630d00efa949","version":"5939d621c78839000f4c0030","category":"5994e2ee9a41b8000f1fcb34","user":"54c933e34574700d00f016f4","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-06-08T23:00:21.610Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":201,"language":"json","code":"{\n    \"errors\": [],\n    \"results\": [\n        {\n            \"access_token\": \"2.a.877CmIRBQeaoCl8iJxKdpA.QWIl7XiTqoFaUGWoBsfd1L9i_O2lQi3Ot49zHl1xf0c.OrUjBlPTVS1-OuenqOV1mqIXRt6MaJZm5WTm6T5u4m8\",\n            \"expires_in\": 86400,\n            \"permissions\": \"public-api\",\n            \"refresh_token\": \"2.r.877CmIRBQeaoCl8iJxKdpA.x5uHcagI8tV1WAAJMSewuLklnLJ_x9jsgG4hHQNJraU.BtmS_OIYm2pLOZ-geZrNlsupQkakcHo1tgIPFvuNOCk\",\n            \"token_type\": \"Bearer\"\n        }\n    ]\n}\n\n","name":""},{"status":401,"language":"text","code":"Unauthorized","name":""}]},"settings":"","auth":"never","params":[],"url":"/public/auth/token","examples":{"codes":[{"code":"curl -u 'username:password' https://api.seed.co/v1/public/auth/token","language":"curl"}]},"method":"post"},"isReference":false,"order":0,"body":"Using the API requires an access token, which must be supplied all authenticated requests.\n\nTokens are short-lived, and stop working once they expire or are revoked. Once tokens expire, they can be refreshed to gain a new access token.\n\nThe token is supplied in the `Authorization` header to make API calls, in the format: `Bearer {access token}`. Here is an example header:\n\n```\nAuthorization: Bearer 2.a.877CmIRBQeaoCl8iJxKdpA.QWIl7XiTqoFaUGWoBsfd1L9i_O2lQi3Ot49zHl1xf0c.OrUjBlPTVS1-OuenqOV1mqIXRt6MaJZm5WTm6T5u4m8\n```\n\n\nGo code sample:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"req := http.NewRequest(\\\"GET\\\", endpointUrl, nil)\\nauthValue := fmt.Sprintf(\\\"Bearer %s\\\", \\\"2.a.877CmIRBQeaoCl8iJxKdpA.QWIl7XiTqoFaUGWoBsfd1L9i_O2lQi3Ot49zHl1xf0c.OrUjBlPTVS1-OuenqOV1mqIXRt6MaJZm5WTm6T5u4m8\\\")\\nreq.Header.Add(\\\"Authorization\\\", authValue)\",\n      \"language\": \"go\"\n    }\n  ]\n}\n[/block]\nTo generate an access token/refresh token pair, supply your username and password using HTTP Basic authentication. On providing valid credentials, an access token will be generated.","excerpt":"Create a new token for use with the public API.","slug":"authentication","type":"post","title":"Create Access Token","__v":1,"parentDoc":null,"childrenPages":[]}

postCreate Access Token

Create a new token for use with the public API.

Using the API requires an access token, which must be supplied all authenticated requests. Tokens are short-lived, and stop working once they expire or are revoked. Once tokens expire, they can be refreshed to gain a new access token. The token is supplied in the `Authorization` header to make API calls, in the format: `Bearer {access token}`. Here is an example header: ``` Authorization: Bearer 2.a.877CmIRBQeaoCl8iJxKdpA.QWIl7XiTqoFaUGWoBsfd1L9i_O2lQi3Ot49zHl1xf0c.OrUjBlPTVS1-OuenqOV1mqIXRt6MaJZm5WTm6T5u4m8 ``` Go code sample: [block:code] { "codes": [ { "code": "req := http.NewRequest(\"GET\", endpointUrl, nil)\nauthValue := fmt.Sprintf(\"Bearer %s\", \"2.a.877CmIRBQeaoCl8iJxKdpA.QWIl7XiTqoFaUGWoBsfd1L9i_O2lQi3Ot49zHl1xf0c.OrUjBlPTVS1-OuenqOV1mqIXRt6MaJZm5WTm6T5u4m8\")\nreq.Header.Add(\"Authorization\", authValue)", "language": "go" } ] } [/block] To generate an access token/refresh token pair, supply your username and password using HTTP Basic authentication. On providing valid credentials, an access token will be generated.

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



Using the API requires an access token, which must be supplied all authenticated requests. Tokens are short-lived, and stop working once they expire or are revoked. Once tokens expire, they can be refreshed to gain a new access token. The token is supplied in the `Authorization` header to make API calls, in the format: `Bearer {access token}`. Here is an example header: ``` Authorization: Bearer 2.a.877CmIRBQeaoCl8iJxKdpA.QWIl7XiTqoFaUGWoBsfd1L9i_O2lQi3Ot49zHl1xf0c.OrUjBlPTVS1-OuenqOV1mqIXRt6MaJZm5WTm6T5u4m8 ``` Go code sample: [block:code] { "codes": [ { "code": "req := http.NewRequest(\"GET\", endpointUrl, nil)\nauthValue := fmt.Sprintf(\"Bearer %s\", \"2.a.877CmIRBQeaoCl8iJxKdpA.QWIl7XiTqoFaUGWoBsfd1L9i_O2lQi3Ot49zHl1xf0c.OrUjBlPTVS1-OuenqOV1mqIXRt6MaJZm5WTm6T5u4m8\")\nreq.Header.Add(\"Authorization\", authValue)", "language": "go" } ] } [/block] To generate an access token/refresh token pair, supply your username and password using HTTP Basic authentication. On providing valid credentials, an access token will be generated.
{"_id":"5994e6fcc0cd1c0019245eec","project":"54c935c60174630d00efa949","version":"5939d621c78839000f4c0030","category":"5994e2ee9a41b8000f1fcb34","user":"54c933e34574700d00f016f4","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-08-17T00:44:44.821Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"language":"curl","code":"curl -X POST \\\n  https://api.seed.co/v1/public/auth/token/refresh \\\n  -H 'content-type: application/json' \\\n  -d '{\"refresh_token\":\"2.r.877CmIRBQeaoCl8iJxKdpA.x5uHcagI8tV1WAAJMSewuLklnLJ_x9jsgG4hHQNJraU.BtmS_OIYm2pLOZ-geZrNlsupQkakcHo1tgIPFvuNOCk\"}'"}]},"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"errors\": [],\n  \"results\": [\n    {\n      \"access_token\": \"2.a.RBAfS2ntRiWyMajaUvmJuw.P3lzr_uDz2_lrHpEnXCb39DILiScB9PhFufCA5BBeZk.DDrTzSBRrVRve1dKYnP398Ss7lLXDp6UyjRhj-WJfGA\",\n      \"expires_in\": 86400,\n      \"permissions\": \"public-api\",\n      \"refresh_token\": \"2.r.RBAfS2ntRiWyMajaUvmJuw.8ootuKHOc_GLqiXjur10kvoWvrNgTPvnhtjV4YsPgiA.PR-uzMpsFQnzaSIvzKMuNAtNds4Yx47CEZVbuiVJDKQ\",\n      \"token_type\": \"Bearer\"\n    }\n  ]\n}\n","name":""},{"status":401,"language":"json","code":"{\n  \"errors\": [\n    {\n      \"message\": \"Unable to validate refresh token.\"\n    }\n  ],\n  \"results\": []\n}","name":""}]},"settings":"","auth":"never","params":[{"_id":"599a3508fe9056000fcc9c22","ref":"","in":"body","required":false,"desc":"The refresh token that will be exchanged for a new access token","default":"","type":"string","name":"refresh_token"}],"url":"/public/auth/token/refresh","method":"post"},"isReference":false,"order":1,"body":"Once an access token expires, a new token can be acquired by using the refresh token.\n\nThe refresh token can be provided through the field `refresh_token` in `application/json` format.","excerpt":"Exchange the refresh token for a new access token.","slug":"refresh-access-token","type":"post","title":"Refresh Access Token","__v":2,"parentDoc":null,"childrenPages":[]}

postRefresh Access Token

Exchange the refresh token for a new access token.

Body Params

refresh_token:
string
The refresh token that will be exchanged for a new access token
Once an access token expires, a new token can be acquired by using the refresh token. The refresh token can be provided through the field `refresh_token` in `application/json` format.

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



Once an access token expires, a new token can be acquired by using the refresh token. The refresh token can be provided through the field `refresh_token` in `application/json` format.
{"_id":"599b2e4ceac604000feda8ac","project":"54c935c60174630d00efa949","version":"5939d621c78839000f4c0030","category":"5994e2ee9a41b8000f1fcb34","user":"54c933e34574700d00f016f4","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-08-21T19:02:36.532Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"method":"get","examples":{"codes":[{"language":"curl","code":"curl -X GET \\\n  https://api.seed.co/v1/public/auth/tokens \\\n  -H 'authorization: Bearer 2.a.RBAfS2ntRiWyMajaUvmJuw.P3lzr_uDz2_lrHpEnXCb39DILiScB9PhFufCA5BBeZk.DDrTzSBRrVRve1dKYnP398Ss7lLXDp6UyjRhj-WJfGA'"}]},"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"results\": [\n    {\n      \"id\": \"8310c25f-2fc9-4dc1-8f15-86fc33acd582\",\n      \"access_token_expires_at\": \"2017-08-22T18:26:45Z\",\n      \"refresh_token_expires_at\": \"2018-08-21T18:26:45Z\",\n      \"created_at\": \"2017-08-21T18:26:45.584613Z\",\n      \"scope\": \"public-api\"\n    }\n  ],\n  \"errors\": []\n}","name":""},{"status":401,"language":"json","code":"{\n  \"errors\": [\n    {\n      \"message\": \"Unauthorized.\"\n    }\n  ],\n  \"results\": []\n}","name":""}]},"settings":"","auth":"required","params":[],"url":"/public/auth/tokens"},"isReference":false,"order":2,"body":"This will also list tokens used for third-party integrations (such as Quickbooks), which also rely on the public API.\n\nNote that web and app sessions are not listed from this endpoint -- we only list public API tokens.","excerpt":"List all generated Public API access tokens.","slug":"list-access-tokens","type":"get","title":"List Access Tokens","__v":0,"parentDoc":null,"childrenPages":[]}

getList Access Tokens

List all generated Public API access tokens.

This will also list tokens used for third-party integrations (such as Quickbooks), which also rely on the public API. Note that web and app sessions are not listed from this endpoint -- we only list public API tokens.

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



This will also list tokens used for third-party integrations (such as Quickbooks), which also rely on the public API. Note that web and app sessions are not listed from this endpoint -- we only list public API tokens.
{"_id":"599b30fa2c071d002fc9a81d","project":"54c935c60174630d00efa949","version":"5939d621c78839000f4c0030","category":"5994e2ee9a41b8000f1fcb34","user":"54c933e34574700d00f016f4","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-08-21T19:14:02.499Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"language":"curl","code":"curl -X POST \\\n  https://localhost:14002/v1/public/auth/token/invalidate \\\n  -H 'authorization: Bearer 2.a.RBAfS2ntRiWyMajaUvmJuw.P3lzr_uDz2_lrHpEnXCb39DILiScB9PhFufCA5BBeZk.DDrTzSBRrVRve1dKYnP398Ss7lLXDp6UyjRhj-WJfGA' \\\n  -H 'content-type: application/json' \\\n  -d '{\"id\":\"44101f4b-69ed-4625-b231-a8da52f989bb\"}'"}]},"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"errors\": [],\n  \"results\": []\n}","name":""},{"status":401,"language":"json","code":"{\n  \"errors\": [\n    {\n      \"message\": \"Not authorized to invalidate the token, or it doesn't exist.\"\n    }\n  ],\n  \"results\": []\n}","name":""}]},"settings":"","auth":"required","params":[{"_id":"599b30fa2c071d002fc9a81e","ref":"","in":"body","required":false,"desc":"The ID of the token to invalidate.","default":"","type":"string","name":"id"}],"url":"/public/auth/token/invalidate","method":"post"},"isReference":false,"order":3,"body":"The token is identified by the `id` field provided in the `List Access Tokens` endpoint.","excerpt":"Invalidates an access token.","slug":"invalidate-access-token","type":"post","title":"Invalidate Access Token","__v":1,"parentDoc":null,"childrenPages":[]}

postInvalidate Access Token

Invalidates an access token.

Body Params

id:
string
The ID of the token to invalidate.
The token is identified by the `id` field provided in the `List Access Tokens` endpoint.

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



The token is identified by the `id` field provided in the `List Access Tokens` endpoint.
{"_id":"5939d7546c83cb003b99c0bc","project":"54c935c60174630d00efa949","version":"5939d621c78839000f4c0030","category":"5994e34bfacb25000f66740b","user":"54c933e34574700d00f016f4","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-06-08T23:01:40.194Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"results\":\n    [\n      {\n        \"id\" : \"472901ae-5473-4089-9dbe-afa71a46e585\",\n        \"checking_account_id\" : \"9d9d21c7-2926-498e-b087-128f8b0e8b42\",\n        \"amount\" : 50,\n        \"status\": \"settled\",\n        \"attachments\" : [],\n        \"date\" : \"2016-12-27T12:00:00Z\",\n        \"category\" : \"Transfers\",\n        \"description\" : \"From Bank Of America 1234\",\n        \"memo\" : \"\"\n      }\n    ]\n}","name":""},{"status":400,"language":"json","code":"{}","name":""},{"status":500,"language":"text","code":""}]},"settings":"","auth":"required","params":[{"_id":"5939d80b4ea7ce000f36df7f","ref":"","in":"query","required":false,"desc":"the status of the transaction, either pending or settled","default":"","type":"string","name":"status"},{"_id":"5939d80b4ea7ce000f36df7e","ref":"","in":"query","required":false,"desc":"The start of a date range","default":"","type":"yyyy-mm-dd","name":"start_date"},{"_id":"5939d80b4ea7ce000f36df7d","ref":"","in":"query","required":false,"desc":"The end of a date range","default":"","type":"yyyy-mm-dd","name":"end_date"},{"_id":"5939d80b4ea7ce000f36df7c","ref":"","in":"query","required":false,"desc":"The offset index used for pagination","default":"0","type":"int","name":"offset"},{"_id":"5939d80b4ea7ce000f36df7b","ref":"","in":"query","required":false,"desc":"The limit used for pagination","default":"1000","type":"int","name":"limit"}],"url":"/public/transactions","examples":{"codes":[{"language":"go","code":"c := http.Client{}\nreq := http.NewRequest(\"GET\", \"https://api.seed.co/public/transactions\", nil)\nauthValue := fmt.Sprintf(\"Bearer %s\", \"2.a.RBAfS2ntRiWyMajaUvmJuw.P3lzr_uDz2_lrHpEnXCb39DILiScB9PhFufCA5BBeZk.DDrTzSBRrVRve1dKYnP398Ss7lLXDp6UyjRhj-WJfGA\")\nreq.Header.Add(\"Authorization\", authValue)\nresp, err := c.Do(req)"},{"code":"import requests\n\nendpoint = \"https://api.seed.co/v1/public/transactions\"\n\nheaders = {\"Authorization\":\"Bearer 2.a.RBAfS2ntRiWyMajaUvmJuw.P3lzr_uDz2_lrHpEnXCb39DILiScB9PhFufCA5BBeZk.DDrTzSBRrVRve1dKYnP398Ss7lLXDp6UyjRhj-WJfGA\"}\n\nresult = requests.get(endpoint,headers=headers).json()","language":"python"},{"language":"curl","code":"curl -X GET \\\n  https://api.seed.co/v1/public/transactions \\\n  -H 'authorization: Bearer 2.a.RBAfS2ntRiWyMajaUvmJuw.P3lzr_uDz2_lrHpEnXCb39DILiScB9PhFufCA5BBeZk.DDrTzSBRrVRve1dKYnP398Ss7lLXDp6UyjRhj-WJfGA'"}]},"method":"get"},"isReference":false,"order":0,"body":"The transactions endpoint returns a list of Seed transactions in date descending order\n[block:api-header]\n{\n  \"title\": \"Transaction Model\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"**id**\",\n    \"0-1\": \"The unique id of this transaction\",\n    \"1-0\": \"**checking_account_id**\",\n    \"1-1\": \"The checking account id associated with this transaction. In most cases, each seed account only has 1 checking account associated with it\",\n    \"2-0\": \"**amount**\",\n    \"2-1\": \"The amount of the transaction **in cents**\",\n    \"3-0\": \"**status**\",\n    \"3-1\": \"The status of the transaction. Possible values are [settled, pending]\",\n    \"4-0\": \"**attachments**\",\n    \"4-1\": \"A list of attachments\",\n    \"5-0\": \"**date**\",\n    \"5-1\": \"The date the transaction took place\",\n    \"6-0\": \"**category**\",\n    \"6-1\": \"The category of the transaction\",\n    \"7-0\": \"**description**\",\n    \"7-1\": \"The description of the transaction\",\n    \"8-0\": \"**memo**\",\n    \"8-1\": \"The user entered memo of the transaction\"\n  },\n  \"cols\": 2,\n  \"rows\": 9\n}\n[/block]","excerpt":"","slug":"transactions","type":"get","title":"List Transactions","__v":3,"parentDoc":null,"childrenPages":[]}

getList Transactions


Query Params

status:
string
the status of the transaction, either pending or settled
start_date:
yyyy-mm-dd
The start of a date range
end_date:
yyyy-mm-dd
The end of a date range
offset:
integer0
The offset index used for pagination
limit:
integer1000
The limit used for pagination
The transactions endpoint returns a list of Seed transactions in date descending order [block:api-header] { "title": "Transaction Model" } [/block] [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "0-0": "**id**", "0-1": "The unique id of this transaction", "1-0": "**checking_account_id**", "1-1": "The checking account id associated with this transaction. In most cases, each seed account only has 1 checking account associated with it", "2-0": "**amount**", "2-1": "The amount of the transaction **in cents**", "3-0": "**status**", "3-1": "The status of the transaction. Possible values are [settled, pending]", "4-0": "**attachments**", "4-1": "A list of attachments", "5-0": "**date**", "5-1": "The date the transaction took place", "6-0": "**category**", "6-1": "The category of the transaction", "7-0": "**description**", "7-1": "The description of the transaction", "8-0": "**memo**", "8-1": "The user entered memo of the transaction" }, "cols": 2, "rows": 9 } [/block]

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



The transactions endpoint returns a list of Seed transactions in date descending order [block:api-header] { "title": "Transaction Model" } [/block] [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "0-0": "**id**", "0-1": "The unique id of this transaction", "1-0": "**checking_account_id**", "1-1": "The checking account id associated with this transaction. In most cases, each seed account only has 1 checking account associated with it", "2-0": "**amount**", "2-1": "The amount of the transaction **in cents**", "3-0": "**status**", "3-1": "The status of the transaction. Possible values are [settled, pending]", "4-0": "**attachments**", "4-1": "A list of attachments", "5-0": "**date**", "5-1": "The date the transaction took place", "6-0": "**category**", "6-1": "The category of the transaction", "7-0": "**description**", "7-1": "The description of the transaction", "8-0": "**memo**", "8-1": "The user entered memo of the transaction" }, "cols": 2, "rows": 9 } [/block]
{"_id":"5941d5a688ac6300230b05c6","project":"54c935c60174630d00efa949","version":"5939d621c78839000f4c0030","category":"5994e34bfacb25000f66740b","user":"5939dc64109baf00336c1130","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-06-15T00:32:38.342Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"method":"get","examples":{"codes":[{"language":"go","code":"c := http.Client{}\nreq := http.NewRequest(\"GET\", \"https://api.seed.co/public/transactions/search?query=Mcdonalds\", nil)\nauthValue := fmt.Sprintf(\"Bearer %s\", \"1.EovnsSPASFGbK_RyfLeQtw.8xsigxghe-s3oxalvibvhvzcgh55jx4qeloumgn9its.8xsigxghe-s3oxalvibvhvzcgh55jx4qeloumgn9its\")\nreq.Header.Add(\"Authorization\", authValue)\nresp, err := c.Do(req)"},{"code":"import requests\n\nendpoint = \"https://api.seed.co/v1/public/transactions/search\"\nquery = \"query=kittens\"\n\nheaders = {\"Authorization\":\"Bearer 1.EovnsSPASFGbK_RyfLeQtw.8xsigxghe-s3oxalvibvhvzcgh55jx4qeloumgn9its.8xsigxghe-s3oxalvibvhvzcgh55jx4qeloumgn9its\"}\n\nresult = requests.get(endpoint + \"?\" + query ,headers=headers).json()","language":"python"}]},"settings":"","results":{"codes":[{"status":200,"language":"json","code":"{\n  \"results\":\n    [\n      {\n        \"id\" : \"472901ae-5473-4089-9dbe-afa71a46e585\",\n        \"checking_account_id\" : \"9d9d21c7-2926-498e-b087-128f8b0e8b42\",\n        \"amount\" : 736,\n        \"status\": \"settled\",\n        \"attachments\" : [],\n        \"date\" : \"2016-12-27T12:00:00Z\",\n        \"category\" : \"Meals & Entertainment\",\n        \"description\" : \"Mcdonalds\",\n        \"memo\" : \"\"\n      }\n    ]\n}","name":""},{"status":400,"language":"json","code":"{}","name":""},{"status":500,"language":"text","code":""}]},"auth":"required","params":[{"_id":"5939d80b4ea7ce000f36df7f","ref":"","in":"query","required":false,"desc":"The query to use for searching transactions","default":"","type":"string","name":"query"},{"_id":"5939d80b4ea7ce000f36df7c","ref":"","in":"query","required":false,"desc":"The offset index used for pagination","default":"0","type":"int","name":"offset"},{"_id":"5939d80b4ea7ce000f36df7b","ref":"","in":"query","required":false,"desc":"The limit used for pagination","default":"1000","type":"int","name":"limit"}],"url":"/public/transactions/search"},"isReference":false,"order":1,"body":"The Transactions Search endpoint takes a query string, and it will do a wildcard search matching the query string to the **description**, **category**, and **memo** fields. If any of these match, the transaction is returned","excerpt":"","slug":"transactions-search","type":"get","title":"Search Transactions","__v":1,"parentDoc":null,"childrenPages":[]}

getSearch Transactions


Query Params

query:
string
The query to use for searching transactions
offset:
integer0
The offset index used for pagination
limit:
integer1000
The limit used for pagination
The Transactions Search endpoint takes a query string, and it will do a wildcard search matching the query string to the **description**, **category**, and **memo** fields. If any of these match, the transaction is returned

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



The Transactions Search endpoint takes a query string, and it will do a wildcard search matching the query string to the **description**, **category**, and **memo** fields. If any of these match, the transaction is returned
{"_id":"59417572bc1ff100194f3109","project":"54c935c60174630d00efa949","version":"5939d621c78839000f4c0030","category":"5994e34bfacb25000f66740b","user":"5939dc64109baf00336c1130","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-06-14T17:42:10.922Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"method":"get","examples":{"codes":[]},"results":{"codes":[{"status":200,"language":"json","code":"{\n   \"errors\" : [],\n   \"results\" : [\n      {\n         \"pending_debits\" : 5892,\n         \"accessible\" : 31932,\n         \"lockbox\" : 0,\n         \"scheduled_debits\" : 0,\n         \"pending_credits\" : 0,\n         \"total_available\" : 31932,\n         \"settled\" : 37824,\n         \"checking_account_id\" : \"dc7839b9-a609-47df-b883-3b8450a7a57e\"\n      }\n   ]\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[],"url":"/public/balance"},"isReference":false,"order":2,"body":"The Balance endpoint gives access to balance information\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"**accessible**\",\n    \"0-1\": \"The balance that you can use. However The **accessible** balance can easily change when the **pending_debits** settle. That's why **total available** is the balance that is \\\"safe to spend\\\".\",\n    \"1-0\": \"**pending_debits**\",\n    \"1-1\": \"Total balance of debit transactions that have not yet settled\",\n    \"2-0\": \"**pending_credits**\",\n    \"2-1\": \"Total balance of credit transactions that have not yet settled\",\n    \"4-0\": \"**settled**\",\n    \"4-1\": \"Total balance of settled transactions\",\n    \"5-0\": \"**lockbox**\",\n    \"5-1\": \"Total balance in the lockbox\",\n    \"6-0\": \"**total_available**\",\n    \"6-1\": \"Total balance that is safe to spend. **total_available** = **accessible** - **pending_debits** - **scheduled_debits**\",\n    \"3-0\": \"**scheduled_debits**\",\n    \"3-1\": \"Total balance of scheduled debit transactions\"\n  },\n  \"cols\": 2,\n  \"rows\": 7\n}\n[/block]","excerpt":"","slug":"balance","type":"get","title":"List Balance","__v":1,"parentDoc":null,"childrenPages":[]}

getList Balance


The Balance endpoint gives access to balance information [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "0-0": "**accessible**", "0-1": "The balance that you can use. However The **accessible** balance can easily change when the **pending_debits** settle. That's why **total available** is the balance that is \"safe to spend\".", "1-0": "**pending_debits**", "1-1": "Total balance of debit transactions that have not yet settled", "2-0": "**pending_credits**", "2-1": "Total balance of credit transactions that have not yet settled", "4-0": "**settled**", "4-1": "Total balance of settled transactions", "5-0": "**lockbox**", "5-1": "Total balance in the lockbox", "6-0": "**total_available**", "6-1": "Total balance that is safe to spend. **total_available** = **accessible** - **pending_debits** - **scheduled_debits**", "3-0": "**scheduled_debits**", "3-1": "Total balance of scheduled debit transactions" }, "cols": 2, "rows": 7 } [/block]

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



The Balance endpoint gives access to balance information [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "0-0": "**accessible**", "0-1": "The balance that you can use. However The **accessible** balance can easily change when the **pending_debits** settle. That's why **total available** is the balance that is \"safe to spend\".", "1-0": "**pending_debits**", "1-1": "Total balance of debit transactions that have not yet settled", "2-0": "**pending_credits**", "2-1": "Total balance of credit transactions that have not yet settled", "4-0": "**settled**", "4-1": "Total balance of settled transactions", "5-0": "**lockbox**", "5-1": "Total balance in the lockbox", "6-0": "**total_available**", "6-1": "Total balance that is safe to spend. **total_available** = **accessible** - **pending_debits** - **scheduled_debits**", "3-0": "**scheduled_debits**", "3-1": "Total balance of scheduled debit transactions" }, "cols": 2, "rows": 7 } [/block]
{"_id":"59b6fff8f9c9e2001075229c","project":"54c935c60174630d00efa949","version":"5939d621c78839000f4c0030","category":"5994e34bfacb25000f66740b","user":"5939dc64109baf00336c1130","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-09-11T21:28:24.426Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"method":"post","examples":{"codes":[]},"results":{"codes":[{"status":200,"language":"json","code":"{\"results\":[],\"errors\":[]}","name":""},{"status":400,"language":"json","code":"{\"errors\":[{\"message\":\"There was invalid data in the request\"}]}","name":""}]},"settings":"","auth":"required","params":[{"_id":"59b6fff8f9c9e2001075229d","ref":"","in":"body","required":false,"desc":"The target url you would like the http post to hit","default":"","type":"string","name":"target_url"}],"url":"/public/webhook/subscribe"},"isReference":false,"order":3,"body":"","excerpt":"","slug":"webhooks","type":"post","title":"Webhooks Subscribe","__v":5,"parentDoc":null,"childrenPages":[]}

postWebhooks Subscribe


Body Params

target_url:
string
The target url you would like the http post to hit

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"_id":"59b700c280b436001a201d96","project":"54c935c60174630d00efa949","version":"5939d621c78839000f4c0030","category":"5994e34bfacb25000f66740b","user":"5939dc64109baf00336c1130","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-09-11T21:31:46.379Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"method":"post","examples":{"codes":[]},"results":{"codes":[{"status":200,"language":"json","code":"{\"results\":[],\"errors\":[]}","name":""},{"status":400,"language":"json","code":"{\"errors\":[{\"message\":\"There was invalid data in the request\"}]}","name":""}]},"settings":"","auth":"required","params":[{"_id":"59b700c280b436001a201d97","ref":"","in":"body","required":false,"desc":"The webhook with the target url that will be unsubscribed","default":"","type":"string","name":"target_url"}],"url":"/public/webhook/unsubscribe"},"isReference":false,"order":4,"body":"","excerpt":"","slug":"webhooks-unsubscribe","type":"post","title":"Webhooks Unsubscribe","__v":4,"parentDoc":null,"childrenPages":[]}

postWebhooks Unsubscribe


Body Params

target_url:
string
The webhook with the target url that will be unsubscribed

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format