{ "info": { "_postman_id": "d01a63e2-8a6c-40a6-8c90-007eeae44719", "name": "Narmi Public account balances reports API", "description": "To read about Public API access and authentication, go to [API Overview](https://docs.narmi.com/docs/narmi-developer-docs/xl9dvbz84o11l-introduction).\n\nContact Support:\n Name: Narmi Support\n Email: support@narmi.com", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-07-28T02:16:40.000Z", "updatedAt": "2026-07-28T02:16:40.000Z", "lastUpdatedBy": "35240", "uid": "35240-d01a63e2-8a6c-40a6-8c90-007eeae44719" }, "item": [ { "name": "v1", "item": [ { "name": "reports", "item": [ { "name": "bai_transaction_types", "item": [ { "name": "List BAI transaction type codes", "id": "4526d551-b2eb-408e-ada9-0ed0edf786f0", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "banking:accounts:read banking:transactions:read banking:scheduled_transfers:read banking:scheduled_transfers:write banking:accounts:write banking:transactions:write banking:users:read banking:products:read banking:documents:read", "type": "string" }, { "key": "accessTokenUrl", "value": "/v2/oauth/token/", "type": "string" }, { "key": "authUrl", "value": "/v2/oauth/authorize/", "type": "string" }, { "key": "grant_type", "value": "authorization_code", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/reports/bai_transaction_types/", "host": [ "{{baseUrl}}" ], "path": [ "v1", "reports", "bai_transaction_types", "" ] }, "description": "Return the institution's configured BAI transaction type codes from core metadata. Each entry includes the 3-digit BAI code, an optional description, and a direction (credit/debit/misc) derived from the code range.\n\nAll monetary values are represented in minor units, or the smallest unit of the currency with no decimal (e.g., cents). For example, $10.00 is represented as 1000.\n\n\n\nHow can we improve these docs? Share your feedback." }, "response": [ { "id": "57a5bbf0-27bf-4702-bab8-0cba3ccdd0de", "name": "New Response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/reports/bai_transaction_types/", "host": [ "{{baseUrl}}" ], "path": [ "v1", "reports", "bai_transaction_types", "" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"code\": \"\",\n \"description\": \"\",\n \"direction\": \"credit\"\n },\n {\n \"code\": \"\",\n \"description\": \"\",\n \"direction\": \"credit\"\n }\n]", "createdAt": "2026-07-28T02:16:40.000Z", "updatedAt": "2026-07-28T02:16:40.000Z", "uid": "35240-57a5bbf0-27bf-4702-bab8-0cba3ccdd0de" } ], "createdAt": "2026-07-28T02:16:40.000Z", "updatedAt": "2026-07-28T02:16:40.000Z", "uid": "35240-4526d551-b2eb-408e-ada9-0ed0edf786f0" } ], "id": "535ab5a5-18dc-4881-870c-8a0a0ea5d8b8", "createdAt": "2026-07-28T02:16:40.000Z", "updatedAt": "2026-07-28T02:16:40.000Z", "uid": "35240-535ab5a5-18dc-4881-870c-8a0a0ea5d8b8" }, { "name": "transactions_download", "item": [ { "name": "Export multi-account transactions", "id": "15405bbf-17c9-456b-85c2-b9e28836b44d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "banking:accounts:read banking:transactions:read banking:scheduled_transfers:read banking:scheduled_transfers:write banking:accounts:write banking:transactions:write banking:users:read banking:products:read banking:documents:read", "type": "string" }, { "key": "accessTokenUrl", "value": "/v2/oauth/token/", "type": "string" }, { "key": "authUrl", "value": "/v2/oauth/authorize/", "type": "string" }, { "key": "grant_type", "value": "authorization_code", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"account_uuids\": [\n \"\"\n ],\n \"max_date\": \"\",\n \"min_date\": \"\",\n \"bai_codes\": [\n \"\",\n \"\"\n ],\n \"format\": \"csv\",\n \"filename\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/reports/transactions_download/", "host": [ "{{baseUrl}}" ], "path": [ "v1", "reports", "transactions_download", "" ] }, "description": "Export transaction history across one or more accounts as CSV or BAI2.\n\nUse the `format` field to select the output format (defaults to `csv`).\n\nUse the optional `filename` field to set a custom filename in the Content-Disposition header.\nIf omitted, a default name like `transaction-export-2024-03-05.csv` is generated.\n\nTransactions are filtered by the specified date range. Optionally, results can be narrowed to\nspecific BAI transaction type codes.\n\nCSV returns columns: Posted Date, Type, Description, Amount, Account, Notes, Balance, Raw Description, BAI Code.\n\nBAI2 returns a spec-compliant BAI2 file with record types 01-99.\n\nAll monetary values are represented in minor units, or the smallest unit of the currency with no decimal (e.g., cents). For example, $10.00 is represented as 1000.\n\n\n\nHow can we improve these docs? Share your feedback." }, "response": [ { "id": "24d50151-0e1c-42db-abac-100e5943b0dc", "name": "Streaming export file (CSV or BAI2) containing matching transactions.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"account_uuids\": [\n \"\"\n ],\n \"max_date\": \"\",\n \"min_date\": \"\",\n \"bai_codes\": [\n \"\",\n \"\"\n ],\n \"format\": \"csv\",\n \"filename\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/reports/transactions_download/", "host": [ "{{baseUrl}}" ], "path": [ "v1", "reports", "transactions_download", "" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T02:16:40.000Z", "updatedAt": "2026-07-28T02:16:40.000Z", "uid": "35240-24d50151-0e1c-42db-abac-100e5943b0dc" }, { "id": "8df74edd-1d60-4a8f-bb55-016f9389bb51", "name": "New Response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"account_uuids\": [\n \"\"\n ],\n \"max_date\": \"\",\n \"min_date\": \"\",\n \"bai_codes\": [\n \"\",\n \"\"\n ],\n \"format\": \"csv\",\n \"filename\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/reports/transactions_download/", "host": [ "{{baseUrl}}" ], "path": [ "v1", "reports", "transactions_download", "" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"invalid_request_error\",\n \"message\": {\n \"field_name\": \"Error description.\"\n }\n}", "createdAt": "2026-07-28T02:16:40.000Z", "updatedAt": "2026-07-28T02:16:40.000Z", "uid": "35240-8df74edd-1d60-4a8f-bb55-016f9389bb51" }, { "id": "4168d47d-31a5-4f10-9cf2-73db9a6bfe7d", "name": "New Response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"account_uuids\": [\n \"\"\n ],\n \"max_date\": \"\",\n \"min_date\": \"\",\n \"bai_codes\": [\n \"\",\n \"\"\n ],\n \"format\": \"csv\",\n \"filename\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/reports/transactions_download/", "host": [ "{{baseUrl}}" ], "path": [ "v1", "reports", "transactions_download", "" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"id\": \"not_found\"\n}", "createdAt": "2026-07-28T02:16:40.000Z", "updatedAt": "2026-07-28T02:16:40.000Z", "uid": "35240-4168d47d-31a5-4f10-9cf2-73db9a6bfe7d" } ], "createdAt": "2026-07-28T02:16:40.000Z", "updatedAt": "2026-07-28T02:16:40.000Z", "uid": "35240-15405bbf-17c9-456b-85c2-b9e28836b44d" } ], "id": "f1112929-5e5f-4b16-a84a-6359c60ad881", "createdAt": "2026-07-28T02:16:40.000Z", "updatedAt": "2026-07-28T02:16:40.000Z", "uid": "35240-f1112929-5e5f-4b16-a84a-6359c60ad881" }, { "name": "transactions_stats", "item": [ { "name": "Get multi-account transaction statistics", "id": "2a3c176d-0e18-41b5-bfe4-a66c8bd03d6b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "banking:accounts:read banking:transactions:read banking:scheduled_transfers:read banking:scheduled_transfers:write banking:accounts:write banking:transactions:write banking:users:read banking:products:read banking:documents:read", "type": "string" }, { "key": "accessTokenUrl", "value": "/v2/oauth/token/", "type": "string" }, { "key": "authUrl", "value": "/v2/oauth/authorize/", "type": "string" }, { "key": "grant_type", "value": "authorization_code", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"account_uuids\": [\n \"\"\n ],\n \"max_date\": \"\",\n \"min_date\": \"\",\n \"bai_codes\": [\n \"\",\n \"\"\n ],\n \"format\": \"csv\",\n \"filename\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/reports/transactions_stats/", "host": [ "{{baseUrl}}" ], "path": [ "v1", "reports", "transactions_stats", "" ] }, "description": "Return aggregate statistics (count, credits, debits, net total) for transactions across one or more accounts within a date range.\n\nOptionally filter by BAI transaction type codes. All monetary values are returned as integers representing amounts in cents.\n\nAll monetary values are represented in minor units, or the smallest unit of the currency with no decimal (e.g., cents). For example, $10.00 is represented as 1000.\n\n\n\nHow can we improve these docs? Share your feedback." }, "response": [ { "id": "fbd4b596-1190-473d-a5f2-fcabc22ecd64", "name": "New Response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"account_uuids\": [\n \"\"\n ],\n \"max_date\": \"\",\n \"min_date\": \"\",\n \"bai_codes\": [\n \"\",\n \"\"\n ],\n \"format\": \"csv\",\n \"filename\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/reports/transactions_stats/", "host": [ "{{baseUrl}}" ], "path": [ "v1", "reports", "transactions_stats", "" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"credits\": \"\",\n \"debits\": \"\",\n \"net_total\": \"\",\n \"transaction_count\": \"\"\n}", "createdAt": "2026-07-28T02:16:40.000Z", "updatedAt": "2026-07-28T02:16:40.000Z", "uid": "35240-fbd4b596-1190-473d-a5f2-fcabc22ecd64" }, { "id": "58de3f52-5dca-4b16-85b0-ecb4b6faff91", "name": "New Response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"account_uuids\": [\n \"\"\n ],\n \"max_date\": \"\",\n \"min_date\": \"\",\n \"bai_codes\": [\n \"\",\n \"\"\n ],\n \"format\": \"csv\",\n \"filename\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/reports/transactions_stats/", "host": [ "{{baseUrl}}" ], "path": [ "v1", "reports", "transactions_stats", "" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"invalid_request_error\",\n \"message\": {\n \"field_name\": \"Error description.\"\n }\n}", "createdAt": "2026-07-28T02:16:40.000Z", "updatedAt": "2026-07-28T02:16:40.000Z", "uid": "35240-58de3f52-5dca-4b16-85b0-ecb4b6faff91" }, { "id": "21434911-be29-4331-83e9-402df84fa627", "name": "New Response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"account_uuids\": [\n \"\"\n ],\n \"max_date\": \"\",\n \"min_date\": \"\",\n \"bai_codes\": [\n \"\",\n \"\"\n ],\n \"format\": \"csv\",\n \"filename\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/reports/transactions_stats/", "host": [ "{{baseUrl}}" ], "path": [ "v1", "reports", "transactions_stats", "" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"id\": \"not_found\"\n}", "createdAt": "2026-07-28T02:16:40.000Z", "updatedAt": "2026-07-28T02:16:40.000Z", "uid": "35240-21434911-be29-4331-83e9-402df84fa627" } ], "createdAt": "2026-07-28T02:16:40.000Z", "updatedAt": "2026-07-28T02:16:40.000Z", "uid": "35240-2a3c176d-0e18-41b5-bfe4-a66c8bd03d6b" } ], "id": "ad7488fa-39b2-469d-9e6e-c93473f714eb", "createdAt": "2026-07-28T02:16:40.000Z", "updatedAt": "2026-07-28T02:16:40.000Z", "uid": "35240-ad7488fa-39b2-469d-9e6e-c93473f714eb" } ], "id": "113263d0-7d2f-4c1d-8407-3fc4e980a969", "createdAt": "2026-07-28T02:16:40.000Z", "updatedAt": "2026-07-28T02:16:40.000Z", "uid": "35240-113263d0-7d2f-4c1d-8407-3fc4e980a969" } ], "id": "5daae253-f4ef-4504-aec1-b68655091f93", "createdAt": "2026-07-28T02:16:40.000Z", "updatedAt": "2026-07-28T02:16:40.000Z", "uid": "35240-5daae253-f4ef-4504-aec1-b68655091f93" } ], "variable": [ { "key": "baseUrl", "value": "https://api.sandbox.narmi.dev/" } ] }