{
  "opencollection": "1.0.0",
  "info": {
    "name": "Synctera Accounts External Accounts API",
    "version": "0.20.0"
  },
  "request": {
    "auth": {
      "type": "bearer",
      "token": "{{bearerToken}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "External Accounts",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List external accounts",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.synctera.com/v0/external_accounts",
            "params": [
              {
                "name": "customer_id",
                "value": "",
                "type": "query",
                "description": "A list of customer unique identifiers, with a comma separating any values."
              },
              {
                "name": "business_id",
                "value": "",
                "type": "query",
                "description": "A list of business unique identifiers, with a comma separating any values."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query"
              },
              {
                "name": "page_token",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Returns a list of all external accounts assigned to customers.\n"
        },
        {
          "info": {
            "name": "Add an external account",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.synctera.com/v0/external_accounts",
            "headers": [
              {
                "name": "Idempotency-Key",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Add an external account for a customer. The account will be created in an unverified state.\n"
        },
        {
          "info": {
            "name": "Get an external account",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.synctera.com/v0/external_accounts/:external_account_id",
            "params": [
              {
                "name": "external_account_id",
                "value": "",
                "type": "path",
                "description": "External Account ID"
              }
            ]
          },
          "docs": "Returns an external account, given an external account ID.\n"
        },
        {
          "info": {
            "name": "Patch an external account",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.synctera.com/v0/external_accounts/:external_account_id",
            "headers": [
              {
                "name": "Idempotency-Key",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "external_account_id",
                "value": "",
                "type": "path",
                "description": "External Account ID"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Edits an unverified external account, given an external account ID.\n"
        },
        {
          "info": {
            "name": "Delete an external account",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.synctera.com/v0/external_accounts/:external_account_id",
            "params": [
              {
                "name": "external_account_id",
                "value": "",
                "type": "path",
                "description": "External Account ID"
              }
            ]
          },
          "docs": "Deletes an external account, given an external account ID. If no accounts left, the access token to the financial institution will be removed\n"
        },
        {
          "info": {
            "name": "Get an external account balance",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.synctera.com/v0/external_accounts/:external_account_id/balance",
            "params": [
              {
                "name": "external_account_id",
                "value": "",
                "type": "path",
                "description": "External Account ID"
              },
              {
                "name": "max_age",
                "value": "",
                "type": "query",
                "description": "Optional relative age of a balance in seconds. If the balance is older than the requested seconds it will fail. This field is optional for most financial institutions, but required for some, so you should probably send it.\n"
              }
            ]
          },
          "docs": "Returns an external account balance, given an external account ID.\n"
        },
        {
          "info": {
            "name": "List transactions of a given external account",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.synctera.com/v0/external_accounts/:external_account_id/transactions",
            "params": [
              {
                "name": "external_account_id",
                "value": "",
                "type": "path",
                "description": "External Account ID"
              },
              {
                "name": "start_date",
                "value": "",
                "type": "query",
                "description": "Date range filtering for transactions. Date is inclusive. Date must be in UTC."
              },
              {
                "name": "end_date",
                "value": "",
                "type": "query",
                "description": "Date range filtering for transactions. Date is exclusive. Date must be in UTC."
              }
            ]
          },
          "docs": "Returns a list of transactions on from the external account, given an external account ID. Maximum 500 transctions will be returned.\n"
        },
        {
          "info": {
            "name": "Create a permanent access token for an external account",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.synctera.com/v0/external_accounts/access_tokens",
            "headers": [
              {
                "name": "Idempotency-Key",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a permanent access token for an external account"
        },
        {
          "info": {
            "name": "Add external accounts through a vendor, such as Plaid.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.synctera.com/v0/external_accounts/add_vendor_accounts",
            "headers": [
              {
                "name": "Idempotency-Key",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Add external accounts for a customer through an existing access token. The token must be valid, and the information on the accounts returned by the vendor must correspond to the customer. A success response for this route may include failures if an account could not be added, so it's important that the caller checks the response body.\n"
        },
        {
          "info": {
            "name": "Create a link token to verify an external account",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.synctera.com/v0/external_accounts/link_tokens",
            "headers": [
              {
                "name": "Idempotency-Key",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a link token to verify an external account"
        },
        {
          "info": {
            "name": "Sync external accounts through a vendor, such as Plaid.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.synctera.com/v0/external_accounts/sync_vendor_accounts",
            "headers": [
              {
                "name": "Idempotency-Key",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Sync external accounts for a customer through an existing access token. The token must be valid, and the information on the accounts returned by the vendor must correspond to the customer. A success response for this route may include failures if an account could not be added and deletions if the account is removed by the end user, so it's important that the caller checks the response body.\n"
        }
      ]
    }
  ],
  "bundled": true
}