{ "opencollection": "1.0.0", "info": { "name": "Argyle Accounts Open Banking API", "version": "2.0" }, "request": { "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "items": [ { "info": { "name": "Open Banking", "type": "folder" }, "items": [ { "info": { "name": "Create a Connect URL", "type": "http" }, "http": { "method": "POST", "url": "https://api.argyle.com/v2/open-banking/connect", "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new Connect URL for the specified user." }, { "info": { "name": "Generate a banking report", "type": "http" }, "http": { "method": "POST", "url": "https://api.argyle.com/v2/open-banking/reports/:type", "params": [ { "name": "type", "value": "", "type": "path", "description": "The type of report to generate." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Generates a new banking report and returns a report object." }, { "info": { "name": "Retrieve a bank account", "type": "http" }, "http": { "method": "GET", "url": "https://api.argyle.com/v2/open-banking/bank-accounts/:bank_account_id", "params": [ { "name": "bank_account_id", "value": "", "type": "path", "description": "ID of the bank account." }, { "name": "user", "value": "", "type": "query", "description": "ID of the user." } ] }, "docs": "Retrieves a bank account." }, { "info": { "name": "List all bank accounts", "type": "http" }, "http": { "method": "GET", "url": "https://api.argyle.com/v2/open-banking/bank-accounts", "params": [ { "name": "user", "value": "", "type": "query", "description": "ID of the user." }, { "name": "limit", "value": "", "type": "query", "description": "Number of bank account objects returned [per page](/api-guide/overview#pagination). Default: 10. Maximum: 200." }, { "name": "cursor", "value": "", "type": "query", "description": "The URL returned in `next` or `previous` used to retrieve another [page](/api-guide/overview#pagination) of results." } ] }, "docs": "Returns a paginated list of the user's bank accounts.\n\nEach result is a bank account object with two bank connection error fields:\n- `error_code` - Bank connection error code. Returned when `aggregation_status_code` indicates an error; otherwise `null`.\n- `error_message` - Bank connection error message. Returned when `aggregation_status_code` indicates an error; otherwise `null`.\n" }, { "info": { "name": "Retrieve an institution", "type": "http" }, "http": { "method": "GET", "url": "https://api.argyle.com/v2/open-banking/institutions/:institution_id", "params": [ { "name": "institution_id", "value": "", "type": "path", "description": "ID of the financial institution." } ] }, "docs": "Retrieves a financial institution." }, { "info": { "name": "List all institutions", "type": "http" }, "http": { "method": "GET", "url": "https://api.argyle.com/v2/open-banking/institutions", "params": [ { "name": "search", "value": "", "type": "query", "description": "Search term (financial institution name)." }, { "name": "type", "value": "", "type": "query", "description": "Report type eligibility.\n\nPossible values:\n- `voa` - Verification of Assets\n- `voi` - Verification of Income\n\nIf `voa` is `true` but `voi` is `false`, VOAI reports contain only asset data.\nIf `voi` is `true` but `voa` is `false`, VOAI reports contain only income data.\n" }, { "name": "limit", "value": "", "type": "query", "description": "Number of institutions per page." }, { "name": "start", "value": "", "type": "query", "description": "Index of page results to return." }, { "name": "cursor", "value": "", "type": "query", "description": "The URL returned in `next` or `previous` used to retrieve another [page](/api-guide/overview#pagination) of results." } ] }, "docs": "Returns a paginated list of supported financial institutions." } ] } ], "bundled": true }