From 235f01a746bea8a7624d6e4b4caee25f2a5d29f3 Mon Sep 17 00:00:00 2001 From: Padma Jadav Date: Thu, 26 Oct 2023 17:02:57 +0530 Subject: [PATCH] Update collection - Payment history endpoint --- openbanking-us.postman_collection.json | 2176 +++++++++++++++++++++--- 1 file changed, 1909 insertions(+), 267 deletions(-) diff --git a/openbanking-us.postman_collection.json b/openbanking-us.postman_collection.json index 9e61354..dbeed24 100644 --- a/openbanking-us.postman_collection.json +++ b/openbanking-us.postman_collection.json @@ -1,10 +1,10 @@ { "info": { - "_postman_id": "f4fa01e4-ab2b-4129-ad60-5c325ff65e13", + "_postman_id": "c24b4c28-a2c4-4baf-8ff8-732267ab183f", "name": "🇺🇸 Mastercard Open Banking US APIs", "description": "Postman Collection for Mastercard Open Banking APIs\n\n\n\nContact Support: \nName: Finicity \nEmail: [business.development@finicity.com](https://mailto:business.development@finicity.com)", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", - "_exporter_id": "20649604" + "_exporter_id": "30686484" }, "item": [ { @@ -7087,11 +7087,6 @@ "request": { "method": "GET", "header": [ - { - "key": "Finicity-App-Key", - "value": "{{appKey}}", - "type": "text" - }, { "key": "Accept", "value": "application/json", @@ -7101,6 +7096,11 @@ "key": "Finicity-App-Token", "value": "{{appToken}}", "type": "text" + }, + { + "key": "Finicity-App-Key", + "value": "{{appKey}}", + "type": "text" } ], "url": { @@ -7115,7 +7115,7 @@ "{{obbReportId}}" ] }, - "description": "Retrieve the report saved by _Generate Balance Analytics_ or _Generate Cash Flow Analytics_. Requires the report ID generated by the previous call.\n\nReport data can either be retrieved as a JSON document or PDF file.\n\n_Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png)" + "description": "Retrieve the report saved by _Generate Balance Analytics_, _Generate Cash Flow Analytics_, or _Generate Payment History_. Requires the report ID generated by the previous call.\n\nReport data can either be retrieved as a JSON document or PDF file.\n\n_Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png)" }, "response": [ { @@ -7123,6 +7123,10 @@ "originalRequest": { "method": "GET", "header": [ + { + "key": "Accept", + "value": "application/json" + }, { "description": "Added as a part of security scheme: apikey", "key": "Finicity-App-Key", @@ -7142,9 +7146,7 @@ ], "variable": [ { - "key": "obb_report_id", - "value": "bcab9592-e032-4e7b-b737-0380619a0573", - "description": "(Required) Report ID generated and returned by OBB products" + "key": "obb_report_id" } ] } @@ -7161,11 +7163,105 @@ "cookie": [], "body": "{\n \"accountResults\": [\n {\n \"accountDetails\": {\n \"accountNumberDisplay\": \"8888\",\n \"accountOwner\": {\n \"address\": \"123 Main St, Portland, OR 12345\",\n \"name\": \"Johnny Appleseed\"\n },\n \"aggregationAttemptDate\": \"2022-03-30T14:47:19-07:00\",\n \"aggregationStatusCode\": 0,\n \"aggregationSuccessDate\": \"2022-03-30T14:47:19-07:00\",\n \"currency\": \"USD\",\n \"currentBalance\": 2239.22,\n \"id\": \"1234902309er\",\n \"institution\": {\n \"institutionIconUrl\": \"https://prod-carpintero-branding.s3.us-west-2.amazonaws.com/101732/icon.svg\",\n \"institutionId\": 12345,\n \"institutionName\": \"Wells Fargo\",\n \"institutionPrimaryColor\": \"#1B3E4A\"\n },\n \"institutionLoginId\": 1007302745,\n \"name\": \"Super Checking\",\n \"realAccountNumberLast4\": 5678,\n \"status\": \"active\",\n \"type\": \"checking\"\n },\n \"accountId\": 5001127492,\n \"balanceAnalyticsMetrics\": {\n \"availableBalance\": {\n \"description\": \"Available Balance\",\n \"example\": 1000.01,\n \"type\": \"number\"\n },\n \"availableBalanceDate\": {\n \"description\": \"Available Balance date\",\n \"example\": \"2022-02-18T02:34:00-07:00\",\n \"type\": \"string\",\n \"minLength\": 25,\n \"maxLength\": 25\n },\n \"averageDailyBalanceByMonthForTheReportTimePeriod\": [\n {\n \"amount\": 890.99,\n \"period\": \"last30to1\",\n \"periodBeginDate\": \"2022-03-01\",\n \"periodEndDate\": \"2022-03-30\"\n }\n ],\n \"averageDailyBalanceForTheReportTimePeriod\": {\n \"description\": \"Average Daily Balance\",\n \"example\": -10442.53,\n \"type\": \"number\"\n },\n \"averageWeekdayBalanceForTheReportTimePeriod\": {\n \"description\": \"Average Weekday Balance\",\n \"example\": -10442.53,\n \"type\": \"number\"\n },\n \"countDailyNegativeBalancesByMonthForTheReportTimePeriod\": [\n {\n \"count\": 5,\n \"period\": \"last30to1\",\n \"periodBeginDate\": \"2022-03-01\",\n \"periodEndDate\": \"2022-03-30\"\n }\n ],\n \"currentRunningBalance\": {\n \"description\": \"Current Running Balance Date\",\n \"example\": 1000.01,\n \"type\": \"number\"\n },\n \"currentRunningBalanceDate\": {\n \"description\": \"Current Running Balance date\",\n \"example\": \"2022-02-10T05:00:00-07:00\",\n \"type\": \"string\",\n \"minLength\": 25,\n \"maxLength\": 25\n },\n \"dailyBalancesByWeekdayForTheReportTimePeriod\": [\n {\n \"date\": \"2021-10-11\",\n \"dayOfWeek\": \"Monday\",\n \"endingBalance\": 21527.3\n }\n ],\n \"dailyBalancesForTheReportTimePeriod\": [\n {\n \"date\": \"2021-10-11\",\n \"dayOfWeek\": \"Monday\",\n \"endingBalance\": 21527.3\n }\n ],\n \"historicNumberOfWeeksAverageBalanceIncreasing\": {\n \"historicAverageWeeklyBalances\": [\n {\n \"amount\": 679.07,\n \"fromDate\": \"2020-01-01\",\n \"toDate\": \"2020-01-07\",\n \"week\": 1\n }\n ],\n \"historicNumberOfWeeksAverageBalanceIncreasing\": 3,\n \"historicNumberOfWeeksWithDataAvailable\": 4\n },\n \"maximumDailyBalanceByMonthForTheReportTimePeriod\": [\n {\n \"amount\": 890.99,\n \"period\": \"last30to1\",\n \"periodBeginDate\": \"2022-03-01\",\n \"periodEndDate\": \"2022-03-30\"\n }\n ],\n \"maximumRunningBalanceForTheReportTimePeriod\": -28749.44,\n \"minimumDailyBalanceByMonthForTheReportTimePeriod\": [\n {\n \"amount\": 890.99,\n \"period\": \"last30to1\",\n \"periodBeginDate\": \"2022-03-01\",\n \"periodEndDate\": \"2022-03-30\"\n }\n ],\n \"minimumRunningBalanceForTheReportTimePeriod\": -28749.44\n },\n \"currentReportRequest\": {\n \"reportBeginDate\": \"2022-03-01\",\n \"reportEndDate\": \"2022-03-30\",\n \"reportRequestDate\": \"2022-03-30T14:47:19-07:00\",\n \"requestedDaysForReport\": 90,\n \"requestedReportBeginDate\": \"2022-01-01\"\n },\n \"historicDataAvailability\": {\n \"historicAvailabilityBeginDate\": \"2022-03-01\",\n \"historicAvailabilityEndDate\": \"2022-03-30\",\n \"historicAvailableDays\": 30,\n \"historicDataAvailability\": \"Data is available from 2022-03-01 to 2022-03-30\"\n }\n }\n ],\n \"businessId\": 4444,\n \"businessSummary\": {\n \"balanceAnalyticsMetrics\": {\n \"availableBalance\": {\n \"description\": \"Available Balance\",\n \"example\": 1000.01,\n \"type\": \"number\"\n },\n \"availableBalanceDate\": {\n \"description\": \"Available Balance date\",\n \"example\": \"2022-02-18T02:34:00-07:00\",\n \"type\": \"string\",\n \"minLength\": 25,\n \"maxLength\": 25\n },\n \"averageDailyBalanceByMonthForTheReportTimePeriod\": [\n {\n \"amount\": 890.99,\n \"period\": \"last30to1\",\n \"periodBeginDate\": \"2022-03-01\",\n \"periodEndDate\": \"2022-03-30\"\n }\n ],\n \"averageDailyBalanceForTheReportTimePeriod\": {\n \"description\": \"Average Daily Balance\",\n \"example\": -10442.53,\n \"type\": \"number\"\n },\n \"averageWeekdayBalanceForTheReportTimePeriod\": {\n \"description\": \"Average Weekday Balance\",\n \"example\": -10442.53,\n \"type\": \"number\"\n },\n \"countDailyNegativeBalancesByMonthForTheReportTimePeriod\": [\n {\n \"count\": 5,\n \"period\": \"last30to1\",\n \"periodBeginDate\": \"2022-03-01\",\n \"periodEndDate\": \"2022-03-30\"\n }\n ],\n \"currentRunningBalance\": {\n \"description\": \"Current Running Balance Date\",\n \"example\": 1000.01,\n \"type\": \"number\"\n },\n \"currentRunningBalanceDate\": {\n \"description\": \"Current Running Balance date\",\n \"example\": \"2022-02-10T05:00:00-07:00\",\n \"type\": \"string\",\n \"minLength\": 25,\n \"maxLength\": 25\n },\n \"dailyBalancesByWeekdayForTheReportTimePeriod\": [\n {\n \"date\": \"2021-10-11\",\n \"dayOfWeek\": \"Monday\",\n \"endingBalance\": 21527.3\n }\n ],\n \"dailyBalancesForTheReportTimePeriod\": [\n {\n \"date\": \"2021-10-11\",\n \"dayOfWeek\": \"Monday\",\n \"endingBalance\": 21527.3\n }\n ],\n \"historicNumberOfWeeksAverageBalanceIncreasing\": {\n \"historicAverageWeeklyBalances\": [\n {\n \"amount\": 679.07,\n \"fromDate\": \"2020-01-01\",\n \"toDate\": \"2020-01-07\",\n \"week\": 1\n }\n ],\n \"historicNumberOfWeeksAverageBalanceIncreasing\": 3,\n \"historicNumberOfWeeksWithDataAvailable\": 4\n },\n \"maximumDailyBalanceByMonthForTheReportTimePeriod\": [\n {\n \"amount\": 890.99,\n \"period\": \"last30to1\",\n \"periodBeginDate\": \"2022-03-01\",\n \"periodEndDate\": \"2022-03-30\"\n }\n ],\n \"maximumRunningBalanceForTheReportTimePeriod\": -28749.44,\n \"minimumDailyBalanceByMonthForTheReportTimePeriod\": [\n {\n \"amount\": 890.99,\n \"period\": \"last30to1\",\n \"periodBeginDate\": \"2022-03-01\",\n \"periodEndDate\": \"2022-03-30\"\n }\n ],\n \"minimumRunningBalanceForTheReportTimePeriod\": -28749.44\n },\n \"currentReportRequest\": {\n \"reportBeginDate\": \"2022-03-01\",\n \"reportEndDate\": \"2022-03-30\",\n \"reportRequestDate\": \"2022-03-30T14:47:19-07:00\",\n \"requestedDaysForReport\": 90,\n \"requestedReportBeginDate\": \"2022-01-01\"\n },\n \"historicDataAvailability\": {\n \"historicAvailabilityBeginDate\": \"2022-03-01\",\n \"historicAvailabilityEndDate\": \"2022-03-30\",\n \"historicAvailableDays\": 30,\n \"historicDataAvailability\": \"Data is available from 2022-03-01 to 2022-03-30\"\n }\n },\n \"customerId\": 10001,\n \"reportHeader\": {\n \"businessAddress\": \"123 Main St\",\n \"businessCity\": \"Portland\",\n \"businessName\": \"B&G Construction\",\n \"businessState\": \"OR\",\n \"businessZip\": \"12345\",\n \"referenceNumber\": \"32asdfaasd0823\",\n \"reportDate\": \"2022-03-16T21:28:38-07:00\",\n \"reportId\": \"8ff8b4b2-706f-45c3-8d66-857bdb516214\"\n },\n \"requesterName\": \"Mortgage ABC LLC\",\n \"title\": \"Fincity Balance Analytics\"\n}" }, + { + "name": "Unauthorized request", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": "Added as a part of security scheme: apikey", + "key": "Finicity-App-Key", + "value": "" + } + ], + "url": { + "raw": "{{baseUrl}}/analytics/data/v1/:obb_report_id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "analytics", + "data", + "v1", + ":obb_report_id" + ], + "variable": [ + { + "key": "obb_report_id" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"errorCode\": 401,\n \"message\": \"Invalid Finicity-App-Key\"\n}" + }, + { + "name": "Access forbidden", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": "Added as a part of security scheme: apikey", + "key": "Finicity-App-Key", + "value": "" + } + ], + "url": { + "raw": "{{baseUrl}}/analytics/data/v1/:obb_report_id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "analytics", + "data", + "v1", + ":obb_report_id" + ], + "variable": [ + { + "key": "obb_report_id" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"errorCode\": 403,\n \"message\": \"Partner does not have access to this resource\"\n}" + }, { "name": "The resource doesn't exist", "originalRequest": { "method": "GET", "header": [ + { + "key": "Accept", + "value": "application/json" + }, { "description": "Added as a part of security scheme: apikey", "key": "Finicity-App-Key", @@ -7185,9 +7281,7 @@ ], "variable": [ { - "key": "obb_report_id", - "value": "bcab9592-e032-4e7b-b737-0380619a0573", - "description": "(Required) Report ID generated and returned by OBB products" + "key": "obb_report_id" } ] } @@ -7211,20 +7305,19 @@ "request": { "method": "GET", "header": [ - { - "key": "Finicity-App-Key", - "value": "{{appKey}}", - "type": "text" - }, { "key": "Accept", - "value": "application/json", - "type": "text" + "value": "application/json" }, { "key": "Finicity-App-Token", "value": "{{appToken}}", "type": "text" + }, + { + "key": "Finicity-App-Key", + "value": "{{appKey}}", + "type": "text" } ], "url": { @@ -7247,7 +7340,7 @@ } ] }, - "description": "Retrieve the report saved by _Generate Balance Analytics - FCRA_ or _Generate Cash Flow Analytics - FCRA_. Requires the report ID generated by the previous call.\n\nReport data can either be retrieved as a JSON document or PDF file.\n\n*Note:* this is a premium service, billable per every successful API call for non-testing customers.\n\n_Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png)" + "description": "Retrieve the report saved by _Generate Balance Analytics - FCRA_, _Generate Cash Flow Analytics - FCRA_, or _Generate Payment History - FCRA_. Requires the report ID generated by the previous call.\n\nReport data can either be retrieved as a JSON document or PDF file.\n\n_Note:_ this is a premium service, billable per every successful API call for non-testing customers.\n\n_Supported regions_:\n\n\"🇺🇸\"" }, "response": [ { @@ -7255,6 +7348,10 @@ "originalRequest": { "method": "GET", "header": [ + { + "key": "Accept", + "value": "application/json" + }, { "description": "Added as a part of security scheme: apikey", "key": "Finicity-App-Key", @@ -7276,14 +7373,13 @@ "query": [ { "key": "purpose", - "value": "31" + "value": "31", + "description": "(Required) 2-digit code from [Permissible Purpose Codes](https://docs.finicity.com/permissible-purpose-codes/), specifying the reason for retrieving this report. Required for retrieving some reports." } ], "variable": [ { - "key": "obb_report_id", - "value": "bcab9592-e032-4e7b-b737-0380619a0573", - "description": "(Required) Report ID generated and returned by OBB products" + "key": "obb_report_id" } ] } @@ -7300,11 +7396,121 @@ "cookie": [], "body": "{\n \"accountResults\": [\n {\n \"accountDetails\": {\n \"accountNumberDisplay\": \"8888\",\n \"accountOwner\": {\n \"address\": \"123 Main St, Portland, OR 12345\",\n \"name\": \"Johnny Appleseed\"\n },\n \"aggregationAttemptDate\": \"2022-03-30T14:47:19-07:00\",\n \"aggregationStatusCode\": 0,\n \"aggregationSuccessDate\": \"2022-03-30T14:47:19-07:00\",\n \"currency\": \"USD\",\n \"currentBalance\": 2239.22,\n \"id\": \"1234902309er\",\n \"institution\": {\n \"institutionIconUrl\": \"https://prod-carpintero-branding.s3.us-west-2.amazonaws.com/101732/icon.svg\",\n \"institutionId\": 12345,\n \"institutionName\": \"Wells Fargo\",\n \"institutionPrimaryColor\": \"#1B3E4A\"\n },\n \"institutionLoginId\": 1007302745,\n \"name\": \"Super Checking\",\n \"realAccountNumberLast4\": 5678,\n \"status\": \"active\",\n \"type\": \"checking\"\n },\n \"accountId\": 5001127492,\n \"balanceAnalyticsMetrics\": {\n \"availableBalance\": {\n \"description\": \"Available Balance\",\n \"example\": 1000.01,\n \"type\": \"number\"\n },\n \"availableBalanceDate\": {\n \"description\": \"Available Balance date\",\n \"example\": \"2022-02-18T02:34:00-07:00\",\n \"type\": \"string\",\n \"minLength\": 25,\n \"maxLength\": 25\n },\n \"averageDailyBalanceByMonthForTheReportTimePeriod\": [\n {\n \"amount\": 890.99,\n \"period\": \"last30to1\",\n \"periodBeginDate\": \"2022-03-01\",\n \"periodEndDate\": \"2022-03-30\"\n }\n ],\n \"averageDailyBalanceForTheReportTimePeriod\": {\n \"description\": \"Average Daily Balance\",\n \"example\": -10442.53,\n \"type\": \"number\"\n },\n \"averageWeekdayBalanceForTheReportTimePeriod\": {\n \"description\": \"Average Weekday Balance\",\n \"example\": -10442.53,\n \"type\": \"number\"\n },\n \"countDailyNegativeBalancesByMonthForTheReportTimePeriod\": [\n {\n \"count\": 5,\n \"period\": \"last30to1\",\n \"periodBeginDate\": \"2022-03-01\",\n \"periodEndDate\": \"2022-03-30\"\n }\n ],\n \"currentRunningBalance\": {\n \"description\": \"Current Running Balance Date\",\n \"example\": 1000.01,\n \"type\": \"number\"\n },\n \"currentRunningBalanceDate\": {\n \"description\": \"Current Running Balance date\",\n \"example\": \"2022-02-10T05:00:00-07:00\",\n \"type\": \"string\",\n \"minLength\": 25,\n \"maxLength\": 25\n },\n \"dailyBalancesByWeekdayForTheReportTimePeriod\": [\n {\n \"date\": \"2021-10-11\",\n \"dayOfWeek\": \"Monday\",\n \"endingBalance\": 21527.3\n }\n ],\n \"dailyBalancesForTheReportTimePeriod\": [\n {\n \"date\": \"2021-10-11\",\n \"dayOfWeek\": \"Monday\",\n \"endingBalance\": 21527.3\n }\n ],\n \"historicNumberOfWeeksAverageBalanceIncreasing\": {\n \"historicAverageWeeklyBalances\": [\n {\n \"amount\": 679.07,\n \"fromDate\": \"2020-01-01\",\n \"toDate\": \"2020-01-07\",\n \"week\": 1\n }\n ],\n \"historicNumberOfWeeksAverageBalanceIncreasing\": 3,\n \"historicNumberOfWeeksWithDataAvailable\": 4\n },\n \"maximumDailyBalanceByMonthForTheReportTimePeriod\": [\n {\n \"amount\": 890.99,\n \"period\": \"last30to1\",\n \"periodBeginDate\": \"2022-03-01\",\n \"periodEndDate\": \"2022-03-30\"\n }\n ],\n \"maximumRunningBalanceForTheReportTimePeriod\": -28749.44,\n \"minimumDailyBalanceByMonthForTheReportTimePeriod\": [\n {\n \"amount\": 890.99,\n \"period\": \"last30to1\",\n \"periodBeginDate\": \"2022-03-01\",\n \"periodEndDate\": \"2022-03-30\"\n }\n ],\n \"minimumRunningBalanceForTheReportTimePeriod\": -28749.44\n },\n \"currentReportRequest\": {\n \"reportBeginDate\": \"2022-03-01\",\n \"reportEndDate\": \"2022-03-30\",\n \"reportRequestDate\": \"2022-03-30T14:47:19-07:00\",\n \"requestedDaysForReport\": 90,\n \"requestedReportBeginDate\": \"2022-01-01\"\n },\n \"historicDataAvailability\": {\n \"historicAvailabilityBeginDate\": \"2022-03-01\",\n \"historicAvailabilityEndDate\": \"2022-03-30\",\n \"historicAvailableDays\": 30,\n \"historicDataAvailability\": \"Data is available from 2022-03-01 to 2022-03-30\"\n }\n }\n ],\n \"businessId\": 4444,\n \"businessSummary\": {\n \"balanceAnalyticsMetrics\": {\n \"availableBalance\": {\n \"description\": \"Available Balance\",\n \"example\": 1000.01,\n \"type\": \"number\"\n },\n \"availableBalanceDate\": {\n \"description\": \"Available Balance date\",\n \"example\": \"2022-02-18T02:34:00-07:00\",\n \"type\": \"string\",\n \"minLength\": 25,\n \"maxLength\": 25\n },\n \"averageDailyBalanceByMonthForTheReportTimePeriod\": [\n {\n \"amount\": 890.99,\n \"period\": \"last30to1\",\n \"periodBeginDate\": \"2022-03-01\",\n \"periodEndDate\": \"2022-03-30\"\n }\n ],\n \"averageDailyBalanceForTheReportTimePeriod\": {\n \"description\": \"Average Daily Balance\",\n \"example\": -10442.53,\n \"type\": \"number\"\n },\n \"averageWeekdayBalanceForTheReportTimePeriod\": {\n \"description\": \"Average Weekday Balance\",\n \"example\": -10442.53,\n \"type\": \"number\"\n },\n \"countDailyNegativeBalancesByMonthForTheReportTimePeriod\": [\n {\n \"count\": 5,\n \"period\": \"last30to1\",\n \"periodBeginDate\": \"2022-03-01\",\n \"periodEndDate\": \"2022-03-30\"\n }\n ],\n \"currentRunningBalance\": {\n \"description\": \"Current Running Balance Date\",\n \"example\": 1000.01,\n \"type\": \"number\"\n },\n \"currentRunningBalanceDate\": {\n \"description\": \"Current Running Balance date\",\n \"example\": \"2022-02-10T05:00:00-07:00\",\n \"type\": \"string\",\n \"minLength\": 25,\n \"maxLength\": 25\n },\n \"dailyBalancesByWeekdayForTheReportTimePeriod\": [\n {\n \"date\": \"2021-10-11\",\n \"dayOfWeek\": \"Monday\",\n \"endingBalance\": 21527.3\n }\n ],\n \"dailyBalancesForTheReportTimePeriod\": [\n {\n \"date\": \"2021-10-11\",\n \"dayOfWeek\": \"Monday\",\n \"endingBalance\": 21527.3\n }\n ],\n \"historicNumberOfWeeksAverageBalanceIncreasing\": {\n \"historicAverageWeeklyBalances\": [\n {\n \"amount\": 679.07,\n \"fromDate\": \"2020-01-01\",\n \"toDate\": \"2020-01-07\",\n \"week\": 1\n }\n ],\n \"historicNumberOfWeeksAverageBalanceIncreasing\": 3,\n \"historicNumberOfWeeksWithDataAvailable\": 4\n },\n \"maximumDailyBalanceByMonthForTheReportTimePeriod\": [\n {\n \"amount\": 890.99,\n \"period\": \"last30to1\",\n \"periodBeginDate\": \"2022-03-01\",\n \"periodEndDate\": \"2022-03-30\"\n }\n ],\n \"maximumRunningBalanceForTheReportTimePeriod\": -28749.44,\n \"minimumDailyBalanceByMonthForTheReportTimePeriod\": [\n {\n \"amount\": 890.99,\n \"period\": \"last30to1\",\n \"periodBeginDate\": \"2022-03-01\",\n \"periodEndDate\": \"2022-03-30\"\n }\n ],\n \"minimumRunningBalanceForTheReportTimePeriod\": -28749.44\n },\n \"currentReportRequest\": {\n \"reportBeginDate\": \"2022-03-01\",\n \"reportEndDate\": \"2022-03-30\",\n \"reportRequestDate\": \"2022-03-30T14:47:19-07:00\",\n \"requestedDaysForReport\": 90,\n \"requestedReportBeginDate\": \"2022-01-01\"\n },\n \"historicDataAvailability\": {\n \"historicAvailabilityBeginDate\": \"2022-03-01\",\n \"historicAvailabilityEndDate\": \"2022-03-30\",\n \"historicAvailableDays\": 30,\n \"historicDataAvailability\": \"Data is available from 2022-03-01 to 2022-03-30\"\n }\n },\n \"customerId\": 10001,\n \"reportHeader\": {\n \"businessAddress\": \"123 Main St\",\n \"businessCity\": \"Portland\",\n \"businessName\": \"B&G Construction\",\n \"businessState\": \"OR\",\n \"businessZip\": \"12345\",\n \"referenceNumber\": \"32asdfaasd0823\",\n \"reportDate\": \"2022-03-16T21:28:38-07:00\",\n \"reportId\": \"8ff8b4b2-706f-45c3-8d66-857bdb516214\"\n },\n \"requesterName\": \"Mortgage ABC LLC\",\n \"title\": \"Fincity Balance Analytics\"\n}" }, + { + "name": "Unauthorized request", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": "Added as a part of security scheme: apikey", + "key": "Finicity-App-Key", + "value": "" + } + ], + "url": { + "raw": "{{baseUrl}}/analytics/data/v1/:obb_report_id/fcra?purpose=31", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "analytics", + "data", + "v1", + ":obb_report_id", + "fcra" + ], + "query": [ + { + "key": "purpose", + "value": "31", + "description": "(Required) 2-digit code from [Permissible Purpose Codes](https://docs.finicity.com/permissible-purpose-codes/), specifying the reason for retrieving this report. Required for retrieving some reports." + } + ], + "variable": [ + { + "key": "obb_report_id" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"errorCode\": 401,\n \"message\": \"Invalid Finicity-App-Key\"\n}" + }, + { + "name": "Access forbidden", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": "Added as a part of security scheme: apikey", + "key": "Finicity-App-Key", + "value": "" + } + ], + "url": { + "raw": "{{baseUrl}}/analytics/data/v1/:obb_report_id/fcra?purpose=31", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "analytics", + "data", + "v1", + ":obb_report_id", + "fcra" + ], + "query": [ + { + "key": "purpose", + "value": "31", + "description": "(Required) 2-digit code from [Permissible Purpose Codes](https://docs.finicity.com/permissible-purpose-codes/), specifying the reason for retrieving this report. Required for retrieving some reports." + } + ], + "variable": [ + { + "key": "obb_report_id" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"errorCode\": 403,\n \"message\": \"Partner does not have access to this resource\"\n}" + }, { "name": "The resource doesn't exist", "originalRequest": { "method": "GET", "header": [ + { + "key": "Accept", + "value": "application/json" + }, { "description": "Added as a part of security scheme: apikey", "key": "Finicity-App-Key", @@ -7326,14 +7532,13 @@ "query": [ { "key": "purpose", - "value": "31" + "value": "31", + "description": "(Required) 2-digit code from [Permissible Purpose Codes](https://docs.finicity.com/permissible-purpose-codes/), specifying the reason for retrieving this report. Required for retrieving some reports." } ], "variable": [ { - "key": "obb_report_id", - "value": "bcab9592-e032-4e7b-b737-0380619a0573", - "description": "(Required) Report ID generated and returned by OBB products" + "key": "obb_report_id" } ] } @@ -7840,7 +8045,7 @@ }, "response": [ { - "name": "The report is being generated. When finished, a notification will be sent to the specified callback URL (Report Listener Service) and the report can be fetched using Get Report APIs. If you don't use a callback URL, Get Report returns a minimal report with the following status: 'inProgress'. Repeat the call every 20 seconds until Get Report returns a different status.", + "name": "The report is being generated. When finished, a notification will be sent to the specified callback URL (Report Listener Service) and the report can be fetched using Get Report APIs. If you don't use a callback URL, Get Report returns a minimal report wit", "originalRequest": { "method": "POST", "header": [ @@ -8155,7 +8360,7 @@ }, "response": [ { - "name": "The report is being generated. When finished, a notification will be sent to the specified callback URL (Report Listener Service) and the report can be fetched using Get Report APIs. If you don't use a callback URL, Get Report returns a minimal report with the following status: 'inProgress'. Repeat the call every 20 seconds until Get Report returns a different status.", + "name": "The report is being generated. When finished, a notification will be sent to the specified callback URL (Report Listener Service) and the report can be fetched using Get Report APIs. If you don't use a callback URL, Get Report returns a minimal report wit", "originalRequest": { "method": "POST", "header": [ @@ -8429,7 +8634,7 @@ }, "response": [ { - "name": "The report is being generated. When finished, a notification will be sent to the specified callback URL (Report Listener Service) and the report can be fetched using Get Report APIs. If you don't use a callback URL, Get Report returns a minimal report with the following status: 'inProgress'. Repeat the call every 20 seconds until Get Report returns a different status.", + "name": "The report is being generated. When finished, a notification will be sent to the specified callback URL (Report Listener Service) and the report can be fetched using Get Report APIs. If you don't use a callback URL, Get Report returns a minimal report wit", "originalRequest": { "method": "POST", "header": [ @@ -9472,11 +9677,6 @@ "request": { "method": "GET", "header": [ - { - "key": "Finicity-App-Key", - "value": "{{appKey}}", - "type": "text" - }, { "key": "Accept", "value": "application/json", @@ -9486,6 +9686,11 @@ "key": "Finicity-App-Token", "value": "{{appToken}}", "type": "text" + }, + { + "key": "Finicity-App-Key", + "value": "{{appKey}}", + "type": "text" } ], "url": { @@ -9500,7 +9705,7 @@ "{{obbReportId}}" ] }, - "description": "Retrieve the report saved by _Generate Balance Analytics_ or _Generate Cash Flow Analytics_. Requires the report ID generated by the previous call.\n\nReport data can either be retrieved as a JSON document or PDF file.\n\n_Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png)" + "description": "Retrieve the report saved by _Generate Balance Analytics_, _Generate Cash Flow Analytics_, or _Generate Payment History_. Requires the report ID generated by the previous call.\n\nReport data can either be retrieved as a JSON document or PDF file.\n\n_Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png)" }, "response": [ { @@ -9508,6 +9713,10 @@ "originalRequest": { "method": "GET", "header": [ + { + "key": "Accept", + "value": "application/json" + }, { "description": "Added as a part of security scheme: apikey", "key": "Finicity-App-Key", @@ -9527,9 +9736,7 @@ ], "variable": [ { - "key": "obb_report_id", - "value": "bcab9592-e032-4e7b-b737-0380619a0573", - "description": "(Required) Report ID generated and returned by OBB products" + "key": "obb_report_id" } ] } @@ -9547,10 +9754,14 @@ "body": "{\n \"accountResults\": [\n {\n \"accountDetails\": {\n \"accountNumberDisplay\": \"8888\",\n \"accountOwner\": {\n \"address\": \"123 Main St, Portland, OR 12345\",\n \"name\": \"Johnny Appleseed\"\n },\n \"aggregationAttemptDate\": \"2022-03-30T14:47:19-07:00\",\n \"aggregationStatusCode\": 0,\n \"aggregationSuccessDate\": \"2022-03-30T14:47:19-07:00\",\n \"currency\": \"USD\",\n \"currentBalance\": 2239.22,\n \"id\": \"1234902309er\",\n \"institution\": {\n \"institutionIconUrl\": \"https://prod-carpintero-branding.s3.us-west-2.amazonaws.com/101732/icon.svg\",\n \"institutionId\": 12345,\n \"institutionName\": \"Wells Fargo\",\n \"institutionPrimaryColor\": \"#1B3E4A\"\n },\n \"institutionLoginId\": 1007302745,\n \"name\": \"Super Checking\",\n \"realAccountNumberLast4\": 5678,\n \"status\": \"active\",\n \"type\": \"checking\"\n },\n \"accountId\": 5001127492,\n \"balanceAnalyticsMetrics\": {\n \"availableBalance\": {\n \"description\": \"Available Balance\",\n \"example\": 1000.01,\n \"type\": \"number\"\n },\n \"availableBalanceDate\": {\n \"description\": \"Available Balance date\",\n \"example\": \"2022-02-18T02:34:00-07:00\",\n \"type\": \"string\",\n \"minLength\": 25,\n \"maxLength\": 25\n },\n \"averageDailyBalanceByMonthForTheReportTimePeriod\": [\n {\n \"amount\": 890.99,\n \"period\": \"last30to1\",\n \"periodBeginDate\": \"2022-03-01\",\n \"periodEndDate\": \"2022-03-30\"\n }\n ],\n \"averageDailyBalanceForTheReportTimePeriod\": {\n \"description\": \"Average Daily Balance\",\n \"example\": -10442.53,\n \"type\": \"number\"\n },\n \"averageWeekdayBalanceForTheReportTimePeriod\": {\n \"description\": \"Average Weekday Balance\",\n \"example\": -10442.53,\n \"type\": \"number\"\n },\n \"countDailyNegativeBalancesByMonthForTheReportTimePeriod\": [\n {\n \"count\": 5,\n \"period\": \"last30to1\",\n \"periodBeginDate\": \"2022-03-01\",\n \"periodEndDate\": \"2022-03-30\"\n }\n ],\n \"currentRunningBalance\": {\n \"description\": \"Current Running Balance Date\",\n \"example\": 1000.01,\n \"type\": \"number\"\n },\n \"currentRunningBalanceDate\": {\n \"description\": \"Current Running Balance date\",\n \"example\": \"2022-02-10T05:00:00-07:00\",\n \"type\": \"string\",\n \"minLength\": 25,\n \"maxLength\": 25\n },\n \"dailyBalancesByWeekdayForTheReportTimePeriod\": [\n {\n \"date\": \"2021-10-11\",\n \"dayOfWeek\": \"Monday\",\n \"endingBalance\": 21527.3\n }\n ],\n \"dailyBalancesForTheReportTimePeriod\": [\n {\n \"date\": \"2021-10-11\",\n \"dayOfWeek\": \"Monday\",\n \"endingBalance\": 21527.3\n }\n ],\n \"historicNumberOfWeeksAverageBalanceIncreasing\": {\n \"historicAverageWeeklyBalances\": [\n {\n \"amount\": 679.07,\n \"fromDate\": \"2020-01-01\",\n \"toDate\": \"2020-01-07\",\n \"week\": 1\n }\n ],\n \"historicNumberOfWeeksAverageBalanceIncreasing\": 3,\n \"historicNumberOfWeeksWithDataAvailable\": 4\n },\n \"maximumDailyBalanceByMonthForTheReportTimePeriod\": [\n {\n \"amount\": 890.99,\n \"period\": \"last30to1\",\n \"periodBeginDate\": \"2022-03-01\",\n \"periodEndDate\": \"2022-03-30\"\n }\n ],\n \"maximumRunningBalanceForTheReportTimePeriod\": -28749.44,\n \"minimumDailyBalanceByMonthForTheReportTimePeriod\": [\n {\n \"amount\": 890.99,\n \"period\": \"last30to1\",\n \"periodBeginDate\": \"2022-03-01\",\n \"periodEndDate\": \"2022-03-30\"\n }\n ],\n \"minimumRunningBalanceForTheReportTimePeriod\": -28749.44\n },\n \"currentReportRequest\": {\n \"reportBeginDate\": \"2022-03-01\",\n \"reportEndDate\": \"2022-03-30\",\n \"reportRequestDate\": \"2022-03-30T14:47:19-07:00\",\n \"requestedDaysForReport\": 90,\n \"requestedReportBeginDate\": \"2022-01-01\"\n },\n \"historicDataAvailability\": {\n \"historicAvailabilityBeginDate\": \"2022-03-01\",\n \"historicAvailabilityEndDate\": \"2022-03-30\",\n \"historicAvailableDays\": 30,\n \"historicDataAvailability\": \"Data is available from 2022-03-01 to 2022-03-30\"\n }\n }\n ],\n \"businessId\": 4444,\n \"businessSummary\": {\n \"balanceAnalyticsMetrics\": {\n \"availableBalance\": {\n \"description\": \"Available Balance\",\n \"example\": 1000.01,\n \"type\": \"number\"\n },\n \"availableBalanceDate\": {\n \"description\": \"Available Balance date\",\n \"example\": \"2022-02-18T02:34:00-07:00\",\n \"type\": \"string\",\n \"minLength\": 25,\n \"maxLength\": 25\n },\n \"averageDailyBalanceByMonthForTheReportTimePeriod\": [\n {\n \"amount\": 890.99,\n \"period\": \"last30to1\",\n \"periodBeginDate\": \"2022-03-01\",\n \"periodEndDate\": \"2022-03-30\"\n }\n ],\n \"averageDailyBalanceForTheReportTimePeriod\": {\n \"description\": \"Average Daily Balance\",\n \"example\": -10442.53,\n \"type\": \"number\"\n },\n \"averageWeekdayBalanceForTheReportTimePeriod\": {\n \"description\": \"Average Weekday Balance\",\n \"example\": -10442.53,\n \"type\": \"number\"\n },\n \"countDailyNegativeBalancesByMonthForTheReportTimePeriod\": [\n {\n \"count\": 5,\n \"period\": \"last30to1\",\n \"periodBeginDate\": \"2022-03-01\",\n \"periodEndDate\": \"2022-03-30\"\n }\n ],\n \"currentRunningBalance\": {\n \"description\": \"Current Running Balance Date\",\n \"example\": 1000.01,\n \"type\": \"number\"\n },\n \"currentRunningBalanceDate\": {\n \"description\": \"Current Running Balance date\",\n \"example\": \"2022-02-10T05:00:00-07:00\",\n \"type\": \"string\",\n \"minLength\": 25,\n \"maxLength\": 25\n },\n \"dailyBalancesByWeekdayForTheReportTimePeriod\": [\n {\n \"date\": \"2021-10-11\",\n \"dayOfWeek\": \"Monday\",\n \"endingBalance\": 21527.3\n }\n ],\n \"dailyBalancesForTheReportTimePeriod\": [\n {\n \"date\": \"2021-10-11\",\n \"dayOfWeek\": \"Monday\",\n \"endingBalance\": 21527.3\n }\n ],\n \"historicNumberOfWeeksAverageBalanceIncreasing\": {\n \"historicAverageWeeklyBalances\": [\n {\n \"amount\": 679.07,\n \"fromDate\": \"2020-01-01\",\n \"toDate\": \"2020-01-07\",\n \"week\": 1\n }\n ],\n \"historicNumberOfWeeksAverageBalanceIncreasing\": 3,\n \"historicNumberOfWeeksWithDataAvailable\": 4\n },\n \"maximumDailyBalanceByMonthForTheReportTimePeriod\": [\n {\n \"amount\": 890.99,\n \"period\": \"last30to1\",\n \"periodBeginDate\": \"2022-03-01\",\n \"periodEndDate\": \"2022-03-30\"\n }\n ],\n \"maximumRunningBalanceForTheReportTimePeriod\": -28749.44,\n \"minimumDailyBalanceByMonthForTheReportTimePeriod\": [\n {\n \"amount\": 890.99,\n \"period\": \"last30to1\",\n \"periodBeginDate\": \"2022-03-01\",\n \"periodEndDate\": \"2022-03-30\"\n }\n ],\n \"minimumRunningBalanceForTheReportTimePeriod\": -28749.44\n },\n \"currentReportRequest\": {\n \"reportBeginDate\": \"2022-03-01\",\n \"reportEndDate\": \"2022-03-30\",\n \"reportRequestDate\": \"2022-03-30T14:47:19-07:00\",\n \"requestedDaysForReport\": 90,\n \"requestedReportBeginDate\": \"2022-01-01\"\n },\n \"historicDataAvailability\": {\n \"historicAvailabilityBeginDate\": \"2022-03-01\",\n \"historicAvailabilityEndDate\": \"2022-03-30\",\n \"historicAvailableDays\": 30,\n \"historicDataAvailability\": \"Data is available from 2022-03-01 to 2022-03-30\"\n }\n },\n \"customerId\": 10001,\n \"reportHeader\": {\n \"businessAddress\": \"123 Main St\",\n \"businessCity\": \"Portland\",\n \"businessName\": \"B&G Construction\",\n \"businessState\": \"OR\",\n \"businessZip\": \"12345\",\n \"referenceNumber\": \"32asdfaasd0823\",\n \"reportDate\": \"2022-03-16T21:28:38-07:00\",\n \"reportId\": \"8ff8b4b2-706f-45c3-8d66-857bdb516214\"\n },\n \"requesterName\": \"Mortgage ABC LLC\",\n \"title\": \"Fincity Balance Analytics\"\n}" }, { - "name": "The resource doesn't exist", + "name": "Unauthorized request", "originalRequest": { "method": "GET", "header": [ + { + "key": "Accept", + "value": "application/json" + }, { "description": "Added as a part of security scheme: apikey", "key": "Finicity-App-Key", @@ -9570,15 +9781,13 @@ ], "variable": [ { - "key": "obb_report_id", - "value": "bcab9592-e032-4e7b-b737-0380619a0573", - "description": "(Required) Report ID generated and returned by OBB products" + "key": "obb_report_id" } ] } }, - "status": "Not Found", - "code": 404, + "status": "Unauthorized", + "code": 401, "_postman_previewlanguage": "json", "header": [ { @@ -9587,41 +9796,130 @@ } ], "cookie": [], - "body": "{\n \"code\": 10100,\n \"message\": \"Cannot find consumer with id 1234.\"\n}" - } - ] - }, - { - "name": "Get OBB Analytics Report - FCRA", - "request": { - "method": "GET", - "header": [ - { - "key": "Finicity-App-Key", - "value": "{{appKey}}", - "type": "text" - }, - { - "key": "Accept", - "value": "application/json", - "type": "text" - }, - { - "key": "Finicity-App-Token", - "value": "{{appToken}}", - "type": "text" - } - ], - "url": { - "raw": "{{baseUrl}}/analytics/data/v1/{{obbFcraReportId}}/fcra?purpose=31", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "analytics", - "data", - "v1", - "{{obbFcraReportId}}", + "body": "{\n \"errorCode\": 401,\n \"message\": \"Invalid Finicity-App-Key\"\n}" + }, + { + "name": "Access forbidden", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": "Added as a part of security scheme: apikey", + "key": "Finicity-App-Key", + "value": "" + } + ], + "url": { + "raw": "{{baseUrl}}/analytics/data/v1/:obb_report_id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "analytics", + "data", + "v1", + ":obb_report_id" + ], + "variable": [ + { + "key": "obb_report_id" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"errorCode\": 403,\n \"message\": \"Partner does not have access to this resource\"\n}" + }, + { + "name": "The resource doesn't exist", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": "Added as a part of security scheme: apikey", + "key": "Finicity-App-Key", + "value": "" + } + ], + "url": { + "raw": "{{baseUrl}}/analytics/data/v1/:obb_report_id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "analytics", + "data", + "v1", + ":obb_report_id" + ], + "variable": [ + { + "key": "obb_report_id" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": 10100,\n \"message\": \"Cannot find consumer with id 1234.\"\n}" + } + ] + }, + { + "name": "Get OBB Analytics Report - FCRA", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Finicity-App-Token", + "value": "{{appToken}}", + "type": "text" + }, + { + "key": "Finicity-App-Key", + "value": "{{appKey}}", + "type": "text" + } + ], + "url": { + "raw": "{{baseUrl}}/analytics/data/v1/{{obbFcraReportId}}/fcra?purpose=31", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "analytics", + "data", + "v1", + "{{obbFcraReportId}}", "fcra" ], "query": [ @@ -9632,7 +9930,7 @@ } ] }, - "description": "Retrieve the report saved by _Generate Balance Analytics - FCRA_ or _Generate Cash Flow Analytics - FCRA_. Requires the report ID generated by the previous call.\n\nReport data can either be retrieved as a JSON document or PDF file.\n\n*Note:* this is a premium service, billable per every successful API call for non-testing customers.\n\n_Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png)" + "description": "Retrieve the report saved by _Generate Balance Analytics - FCRA_, _Generate Cash Flow Analytics - FCRA_, or _Generate Payment History - FCRA_. Requires the report ID generated by the previous call.\n\nReport data can either be retrieved as a JSON document or PDF file.\n\n_Note:_ this is a premium service, billable per every successful API call for non-testing customers.\n\n_Supported regions_:\n\n\"🇺🇸\"" }, "response": [ { @@ -9640,6 +9938,10 @@ "originalRequest": { "method": "GET", "header": [ + { + "key": "Accept", + "value": "application/json" + }, { "description": "Added as a part of security scheme: apikey", "key": "Finicity-App-Key", @@ -9661,14 +9963,13 @@ "query": [ { "key": "purpose", - "value": "31" + "value": "31", + "description": "(Required) 2-digit code from [Permissible Purpose Codes](https://docs.finicity.com/permissible-purpose-codes/), specifying the reason for retrieving this report. Required for retrieving some reports." } ], "variable": [ { - "key": "obb_report_id", - "value": "bcab9592-e032-4e7b-b737-0380619a0573", - "description": "(Required) Report ID generated and returned by OBB products" + "key": "obb_report_id" } ] } @@ -9685,11 +9986,121 @@ "cookie": [], "body": "{\n \"accountResults\": [\n {\n \"accountDetails\": {\n \"accountNumberDisplay\": \"8888\",\n \"accountOwner\": {\n \"address\": \"123 Main St, Portland, OR 12345\",\n \"name\": \"Johnny Appleseed\"\n },\n \"aggregationAttemptDate\": \"2022-03-30T14:47:19-07:00\",\n \"aggregationStatusCode\": 0,\n \"aggregationSuccessDate\": \"2022-03-30T14:47:19-07:00\",\n \"currency\": \"USD\",\n \"currentBalance\": 2239.22,\n \"id\": \"1234902309er\",\n \"institution\": {\n \"institutionIconUrl\": \"https://prod-carpintero-branding.s3.us-west-2.amazonaws.com/101732/icon.svg\",\n \"institutionId\": 12345,\n \"institutionName\": \"Wells Fargo\",\n \"institutionPrimaryColor\": \"#1B3E4A\"\n },\n \"institutionLoginId\": 1007302745,\n \"name\": \"Super Checking\",\n \"realAccountNumberLast4\": 5678,\n \"status\": \"active\",\n \"type\": \"checking\"\n },\n \"accountId\": 5001127492,\n \"balanceAnalyticsMetrics\": {\n \"availableBalance\": {\n \"description\": \"Available Balance\",\n \"example\": 1000.01,\n \"type\": \"number\"\n },\n \"availableBalanceDate\": {\n \"description\": \"Available Balance date\",\n \"example\": \"2022-02-18T02:34:00-07:00\",\n \"type\": \"string\",\n \"minLength\": 25,\n \"maxLength\": 25\n },\n \"averageDailyBalanceByMonthForTheReportTimePeriod\": [\n {\n \"amount\": 890.99,\n \"period\": \"last30to1\",\n \"periodBeginDate\": \"2022-03-01\",\n \"periodEndDate\": \"2022-03-30\"\n }\n ],\n \"averageDailyBalanceForTheReportTimePeriod\": {\n \"description\": \"Average Daily Balance\",\n \"example\": -10442.53,\n \"type\": \"number\"\n },\n \"averageWeekdayBalanceForTheReportTimePeriod\": {\n \"description\": \"Average Weekday Balance\",\n \"example\": -10442.53,\n \"type\": \"number\"\n },\n \"countDailyNegativeBalancesByMonthForTheReportTimePeriod\": [\n {\n \"count\": 5,\n \"period\": \"last30to1\",\n \"periodBeginDate\": \"2022-03-01\",\n \"periodEndDate\": \"2022-03-30\"\n }\n ],\n \"currentRunningBalance\": {\n \"description\": \"Current Running Balance Date\",\n \"example\": 1000.01,\n \"type\": \"number\"\n },\n \"currentRunningBalanceDate\": {\n \"description\": \"Current Running Balance date\",\n \"example\": \"2022-02-10T05:00:00-07:00\",\n \"type\": \"string\",\n \"minLength\": 25,\n \"maxLength\": 25\n },\n \"dailyBalancesByWeekdayForTheReportTimePeriod\": [\n {\n \"date\": \"2021-10-11\",\n \"dayOfWeek\": \"Monday\",\n \"endingBalance\": 21527.3\n }\n ],\n \"dailyBalancesForTheReportTimePeriod\": [\n {\n \"date\": \"2021-10-11\",\n \"dayOfWeek\": \"Monday\",\n \"endingBalance\": 21527.3\n }\n ],\n \"historicNumberOfWeeksAverageBalanceIncreasing\": {\n \"historicAverageWeeklyBalances\": [\n {\n \"amount\": 679.07,\n \"fromDate\": \"2020-01-01\",\n \"toDate\": \"2020-01-07\",\n \"week\": 1\n }\n ],\n \"historicNumberOfWeeksAverageBalanceIncreasing\": 3,\n \"historicNumberOfWeeksWithDataAvailable\": 4\n },\n \"maximumDailyBalanceByMonthForTheReportTimePeriod\": [\n {\n \"amount\": 890.99,\n \"period\": \"last30to1\",\n \"periodBeginDate\": \"2022-03-01\",\n \"periodEndDate\": \"2022-03-30\"\n }\n ],\n \"maximumRunningBalanceForTheReportTimePeriod\": -28749.44,\n \"minimumDailyBalanceByMonthForTheReportTimePeriod\": [\n {\n \"amount\": 890.99,\n \"period\": \"last30to1\",\n \"periodBeginDate\": \"2022-03-01\",\n \"periodEndDate\": \"2022-03-30\"\n }\n ],\n \"minimumRunningBalanceForTheReportTimePeriod\": -28749.44\n },\n \"currentReportRequest\": {\n \"reportBeginDate\": \"2022-03-01\",\n \"reportEndDate\": \"2022-03-30\",\n \"reportRequestDate\": \"2022-03-30T14:47:19-07:00\",\n \"requestedDaysForReport\": 90,\n \"requestedReportBeginDate\": \"2022-01-01\"\n },\n \"historicDataAvailability\": {\n \"historicAvailabilityBeginDate\": \"2022-03-01\",\n \"historicAvailabilityEndDate\": \"2022-03-30\",\n \"historicAvailableDays\": 30,\n \"historicDataAvailability\": \"Data is available from 2022-03-01 to 2022-03-30\"\n }\n }\n ],\n \"businessId\": 4444,\n \"businessSummary\": {\n \"balanceAnalyticsMetrics\": {\n \"availableBalance\": {\n \"description\": \"Available Balance\",\n \"example\": 1000.01,\n \"type\": \"number\"\n },\n \"availableBalanceDate\": {\n \"description\": \"Available Balance date\",\n \"example\": \"2022-02-18T02:34:00-07:00\",\n \"type\": \"string\",\n \"minLength\": 25,\n \"maxLength\": 25\n },\n \"averageDailyBalanceByMonthForTheReportTimePeriod\": [\n {\n \"amount\": 890.99,\n \"period\": \"last30to1\",\n \"periodBeginDate\": \"2022-03-01\",\n \"periodEndDate\": \"2022-03-30\"\n }\n ],\n \"averageDailyBalanceForTheReportTimePeriod\": {\n \"description\": \"Average Daily Balance\",\n \"example\": -10442.53,\n \"type\": \"number\"\n },\n \"averageWeekdayBalanceForTheReportTimePeriod\": {\n \"description\": \"Average Weekday Balance\",\n \"example\": -10442.53,\n \"type\": \"number\"\n },\n \"countDailyNegativeBalancesByMonthForTheReportTimePeriod\": [\n {\n \"count\": 5,\n \"period\": \"last30to1\",\n \"periodBeginDate\": \"2022-03-01\",\n \"periodEndDate\": \"2022-03-30\"\n }\n ],\n \"currentRunningBalance\": {\n \"description\": \"Current Running Balance Date\",\n \"example\": 1000.01,\n \"type\": \"number\"\n },\n \"currentRunningBalanceDate\": {\n \"description\": \"Current Running Balance date\",\n \"example\": \"2022-02-10T05:00:00-07:00\",\n \"type\": \"string\",\n \"minLength\": 25,\n \"maxLength\": 25\n },\n \"dailyBalancesByWeekdayForTheReportTimePeriod\": [\n {\n \"date\": \"2021-10-11\",\n \"dayOfWeek\": \"Monday\",\n \"endingBalance\": 21527.3\n }\n ],\n \"dailyBalancesForTheReportTimePeriod\": [\n {\n \"date\": \"2021-10-11\",\n \"dayOfWeek\": \"Monday\",\n \"endingBalance\": 21527.3\n }\n ],\n \"historicNumberOfWeeksAverageBalanceIncreasing\": {\n \"historicAverageWeeklyBalances\": [\n {\n \"amount\": 679.07,\n \"fromDate\": \"2020-01-01\",\n \"toDate\": \"2020-01-07\",\n \"week\": 1\n }\n ],\n \"historicNumberOfWeeksAverageBalanceIncreasing\": 3,\n \"historicNumberOfWeeksWithDataAvailable\": 4\n },\n \"maximumDailyBalanceByMonthForTheReportTimePeriod\": [\n {\n \"amount\": 890.99,\n \"period\": \"last30to1\",\n \"periodBeginDate\": \"2022-03-01\",\n \"periodEndDate\": \"2022-03-30\"\n }\n ],\n \"maximumRunningBalanceForTheReportTimePeriod\": -28749.44,\n \"minimumDailyBalanceByMonthForTheReportTimePeriod\": [\n {\n \"amount\": 890.99,\n \"period\": \"last30to1\",\n \"periodBeginDate\": \"2022-03-01\",\n \"periodEndDate\": \"2022-03-30\"\n }\n ],\n \"minimumRunningBalanceForTheReportTimePeriod\": -28749.44\n },\n \"currentReportRequest\": {\n \"reportBeginDate\": \"2022-03-01\",\n \"reportEndDate\": \"2022-03-30\",\n \"reportRequestDate\": \"2022-03-30T14:47:19-07:00\",\n \"requestedDaysForReport\": 90,\n \"requestedReportBeginDate\": \"2022-01-01\"\n },\n \"historicDataAvailability\": {\n \"historicAvailabilityBeginDate\": \"2022-03-01\",\n \"historicAvailabilityEndDate\": \"2022-03-30\",\n \"historicAvailableDays\": 30,\n \"historicDataAvailability\": \"Data is available from 2022-03-01 to 2022-03-30\"\n }\n },\n \"customerId\": 10001,\n \"reportHeader\": {\n \"businessAddress\": \"123 Main St\",\n \"businessCity\": \"Portland\",\n \"businessName\": \"B&G Construction\",\n \"businessState\": \"OR\",\n \"businessZip\": \"12345\",\n \"referenceNumber\": \"32asdfaasd0823\",\n \"reportDate\": \"2022-03-16T21:28:38-07:00\",\n \"reportId\": \"8ff8b4b2-706f-45c3-8d66-857bdb516214\"\n },\n \"requesterName\": \"Mortgage ABC LLC\",\n \"title\": \"Fincity Balance Analytics\"\n}" }, + { + "name": "Unauthorized request", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": "Added as a part of security scheme: apikey", + "key": "Finicity-App-Key", + "value": "" + } + ], + "url": { + "raw": "{{baseUrl}}/analytics/data/v1/:obb_report_id/fcra?purpose=31", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "analytics", + "data", + "v1", + ":obb_report_id", + "fcra" + ], + "query": [ + { + "key": "purpose", + "value": "31", + "description": "(Required) 2-digit code from [Permissible Purpose Codes](https://docs.finicity.com/permissible-purpose-codes/), specifying the reason for retrieving this report. Required for retrieving some reports." + } + ], + "variable": [ + { + "key": "obb_report_id" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"errorCode\": 401,\n \"message\": \"Invalid Finicity-App-Key\"\n}" + }, + { + "name": "Access forbidden", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": "Added as a part of security scheme: apikey", + "key": "Finicity-App-Key", + "value": "" + } + ], + "url": { + "raw": "{{baseUrl}}/analytics/data/v1/:obb_report_id/fcra?purpose=31", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "analytics", + "data", + "v1", + ":obb_report_id", + "fcra" + ], + "query": [ + { + "key": "purpose", + "value": "31", + "description": "(Required) 2-digit code from [Permissible Purpose Codes](https://docs.finicity.com/permissible-purpose-codes/), specifying the reason for retrieving this report. Required for retrieving some reports." + } + ], + "variable": [ + { + "key": "obb_report_id" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"errorCode\": 403,\n \"message\": \"Partner does not have access to this resource\"\n}" + }, { "name": "The resource doesn't exist", "originalRequest": { "method": "GET", "header": [ + { + "key": "Accept", + "value": "application/json" + }, { "description": "Added as a part of security scheme: apikey", "key": "Finicity-App-Key", @@ -9711,14 +10122,13 @@ "query": [ { "key": "purpose", - "value": "31" + "value": "31", + "description": "(Required) 2-digit code from [Permissible Purpose Codes](https://docs.finicity.com/permissible-purpose-codes/), specifying the reason for retrieving this report. Required for retrieving some reports." } ], "variable": [ { - "key": "obb_report_id", - "value": "bcab9592-e032-4e7b-b737-0380619a0573", - "description": "(Required) Report ID generated and returned by OBB products" + "key": "obb_report_id" } ] } @@ -16154,44 +16564,1308 @@ } ], "cookie": [], - "body": "{\n \"code\": \"10022\",\n \"status\": \"401\",\n \"message\": \"Invalid authorization credentials\",\n \"user_message\": \"The session has expired or is invalid\",\n \"tags\": \"\"\n}" + "body": "{\n \"code\": \"10022\",\n \"status\": \"401\",\n \"message\": \"Invalid authorization credentials\",\n \"user_message\": \"The session has expired or is invalid\",\n \"tags\": \"\"\n}" + }, + { + "name": "The resource doesn't exist", + "originalRequest": { + "method": "GET", + "header": [ + { + "description": "Added as a part of security scheme: apikey", + "key": "Finicity-App-Key", + "value": "{{appKey}}" + } + ], + "url": { + "raw": "{{baseUrl}}/aggregation/v1/customers/:customerId/accounts/:accountId/availableBalance/live", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "aggregation", + "v1", + "customers", + ":customerId", + "accounts", + ":accountId", + "availableBalance", + "live" + ], + "variable": [ + { + "key": "customerId", + "value": "1005061234", + "description": "(Required) A customer ID" + }, + { + "key": "accountId", + "value": "5011648377", + "description": "(Required) The account ID" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": 10100,\n \"message\": \"Cannot find consumer with id 1234.\"\n}" + } + ] + }, + { + "name": "Get Available Balance", + "event": [ + { + "listen": "test", + "script": { + "exec": [ + "pm.test(\"Check status code\", function () {\r", + " pm.expect(pm.response.code).to.equals(200)\r", + "})" + ], + "type": "text/javascript" + } + } + ], + "request": { + "method": "GET", + "header": [ + { + "key": "Finicity-App-Key", + "value": "{{appKey}}", + "type": "text" + }, + { + "key": "Accept", + "value": "application/json", + "type": "text" + }, + { + "key": "Finicity-App-Token", + "value": "{{appToken}}", + "type": "text" + } + ], + "url": { + "raw": "{{baseUrl}}/aggregation/v1/customers/{{customerId}}/accounts/{{savingAccountId}}/availableBalance", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "aggregation", + "v1", + "customers", + "{{customerId}}", + "accounts", + "{{savingAccountId}}", + "availableBalance" + ] + }, + "description": "Retrieve the latest cached available and cleared account balances for a customer. Since we update and store balances throughout the day, this is the most accurate balance information available when a connection to a financial institution is unavailable or when a faster response is needed. Only deposit account types are supported: Checking, Savings, Money Market, and CD.\n\nNote: this is a premium service, billable per every successful API call. Enrollment is required.\n\n_Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png)" + }, + "response": [ + { + "name": "The balance was successfully retrieved", + "originalRequest": { + "method": "GET", + "header": [ + { + "description": "Added as a part of security scheme: apikey", + "key": "Finicity-App-Key", + "value": "{{appKey}}" + } + ], + "url": { + "raw": "{{baseUrl}}/aggregation/v1/customers/:customerId/accounts/:accountId/availableBalance", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "aggregation", + "v1", + "customers", + ":customerId", + "accounts", + ":accountId", + "availableBalance" + ], + "variable": [ + { + "key": "customerId", + "value": "1005061234", + "description": "(Required) A customer ID" + }, + { + "key": "accountId", + "value": "5011648377", + "description": "(Required) The account ID" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{}" + }, + { + "name": "The request was rejected", + "originalRequest": { + "method": "GET", + "header": [ + { + "description": "Added as a part of security scheme: apikey", + "key": "Finicity-App-Key", + "value": "{{appKey}}" + } + ], + "url": { + "raw": "{{baseUrl}}/aggregation/v1/customers/:customerId/accounts/:accountId/availableBalance", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "aggregation", + "v1", + "customers", + ":customerId", + "accounts", + ":accountId", + "availableBalance" + ], + "variable": [ + { + "key": "customerId", + "value": "1005061234", + "description": "(Required) A customer ID" + }, + { + "key": "accountId", + "value": "5011648377", + "description": "(Required) The account ID" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"10010\",\n \"status\": \"400\",\n \"message\": \"\\\"partnerId\\\" is required\",\n \"user_message\": \"One or more of the fields could not be validated. Please ensure you have entered the correct data.\",\n \"tags\": \"\"\n}" + }, + { + "name": "The request lacks valid authentication credentials. Check \"Finicity-App-Key\" or \"Finicity-App-Token\".", + "originalRequest": { + "method": "GET", + "header": [ + { + "description": "Added as a part of security scheme: apikey", + "key": "Finicity-App-Key", + "value": "{{appKey}}" + } + ], + "url": { + "raw": "{{baseUrl}}/aggregation/v1/customers/:customerId/accounts/:accountId/availableBalance", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "aggregation", + "v1", + "customers", + ":customerId", + "accounts", + ":accountId", + "availableBalance" + ], + "variable": [ + { + "key": "customerId", + "value": "1005061234", + "description": "(Required) A customer ID" + }, + { + "key": "accountId", + "value": "5011648377", + "description": "(Required) The account ID" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"10022\",\n \"status\": \"401\",\n \"message\": \"Invalid authorization credentials\",\n \"user_message\": \"The session has expired or is invalid\",\n \"tags\": \"\"\n}" + }, + { + "name": "The resource doesn't exist", + "originalRequest": { + "method": "GET", + "header": [ + { + "description": "Added as a part of security scheme: apikey", + "key": "Finicity-App-Key", + "value": "{{appKey}}" + } + ], + "url": { + "raw": "{{baseUrl}}/aggregation/v1/customers/:customerId/accounts/:accountId/availableBalance", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "aggregation", + "v1", + "customers", + ":customerId", + "accounts", + ":accountId", + "availableBalance" + ], + "variable": [ + { + "key": "customerId", + "value": "1005061234", + "description": "(Required) A customer ID" + }, + { + "key": "accountId", + "value": "5011648377", + "description": "(Required) The account ID" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": 10100,\n \"message\": \"Cannot find consumer with id 1234.\"\n}" + } + ] + } + ], + "description": "Fetch ACH details and account balances", + "event": [ + { + "listen": "prerequest", + "script": { + "type": "text/javascript", + "exec": [ + "const baseUrl = pm.collectionVariables.get(\"baseUrl\")", + "const appKey = pm.environment.get(\"appKey\")", + "const customerId = pm.environment.get(\"customerId\")", + "const appToken = pm.globals.get(\"appToken\")", + "", + "const savingAccountId = pm.variables.get(\"savingAccountId\")", + "const accountId = pm.variables.get(\"accountId\")", + "if (savingAccountId && accountId) {", + " return", + "}", + "", + "console.log(\"Fetching account IDs\")", + "const options = {", + " url: baseUrl + \"/aggregation/v1/customers/\"+ customerId + \"/accounts\",", + " method: 'GET',", + " header: {", + " \"Accept\": \"application/json\",", + " \"Finicity-App-Key\": appKey,", + " \"Finicity-App-Token\": appToken", + " }", + "}", + "pm.sendRequest(options, function (err, response) {", + " pm.expect(err).to.be.null", + " pm.expect(response.code).to.equals(200)", + " const accounts = response.json().accounts;", + " const account = accounts.filter(a => a.type === \"savings\")[0]", + " pm.variables.set(\"savingAccountId\", account.id)", + " pm.variables.set(\"accountId\", accounts[0].id)", + "})" + ] + } + } + ] + }, + { + "name": "Payment History", + "item": [ + { + "name": "Generate Payment History", + "event": [ + { + "listen": "test", + "script": { + "exec": [ + "pm.test(\"Check status code\", function () {\r", + " pm.expect(pm.response.code).to.equals(200)\r", + "\r", + " /* Store the report ID */\r", + " const reportId = pm.response.json().reportId\r", + " pm.globals.set(\"obbReportId\", reportId)\r", + "})" + ], + "type": "text/javascript" + } + } + ], + "request": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Content-Type", + "value": "application/json", + "type": "text" + }, + { + "key": "Finicity-App-Token", + "value": "{{appToken}}", + "type": "text" + }, + { + "key": "Finicity-App-Key", + "value": "{{appKey}}", + "type": "text" + } + ], + "url": { + "raw": "{{baseUrl}}/analytics/payment-history/v1/customer/{{customerId}}?reference-number=abc123", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "analytics", + "payment-history", + "v1", + "customer", + "{{customerId}}" + ], + "query": [ + { + "key": "reference-number", + "value": "abc123", + "description": "Partner-provided reference number to correlate reports." + } + ] + }, + "description": "Payment history report analyzes up to 12-months of transactions and predicts the probability that a SMB will experience a payment risk event, such as NSF/Overdraft or missed recurring payments, in the near future when making a payment. The Risk Score provided in the report is a 2-digit ranking with four levels of risk going from low to high.\n\nSome of the highlights of calculated risk present in the report include:\n* Risk Score representing the likelihood of a missed payment\n based on analysis of permissioned open-banking data\n\n* Monthly average balance for all accounts by month in the requested\n time period\n\n* Total deposit amount by month for all accounts in the requested time\n period\n\n* Total withdrawal amounts by month for all accounts in the requested\n time period\n\n* Number of NSF counts and aggregate amount per month in the requested\n time period\n\n* Recurring loan payment amounts per month in the requested time period\n* Insurance payment amount per month in the requested time period\n* Tax payment amounts per month in the requested time period\n\nThis version of the API is intended for piloting and integration testing your application with the Payment History product. It does not adhere to FCRA requirements, and should not be used for production/lending purposes. See _Generate Payment History - FCRA_ for the FCRA compliant version of this API.\n\n*Note:* this is a premium service, billable per every successful API call for non-testing customers.\n\nA successful call to this API will generate analytics and store a report within Finicity. The report can be retrieved via _Get OBB Analytics Report_ (operation: _GetObbAnalyticsReport_).\n*Note:* this is a premium service, billable per every successful API call for non-testing customers.\n\n_Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png)" + }, + "response": [ + { + "name": "Response given when payment history was generated successfully, providing the caller with a report ID which can be used to retrieve the report as JSON or a PDF.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": "Added as a part of security scheme: apikey", + "key": "Finicity-App-Key", + "value": "" + } + ], + "url": { + "raw": "{{baseUrl}}/analytics/payment-history/v1/customer/:customerId?reference-number=abc123", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "analytics", + "payment-history", + "v1", + "customer", + ":customerId" + ], + "query": [ + { + "key": "reference-number", + "value": "abc123", + "description": "Partner-provided reference number to correlate reports." + } + ], + "variable": [ + { + "key": "customerId" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"reportId\": \"145cabe0-2b38-4175-9b7e-115431359839\",\n \"reportPin\": \"qert\",\n \"customerId\": 10001,\n \"accountIds\": [\n 10001,\n 10002,\n 10003\n ],\n \"title\": \"Finicity Payment History\",\n \"createdDate\": \"2022-02-10T05:00:00-07:00\",\n \"businessId\": 123,\n \"requesterName\": \"Mortage ABC LLC\"\n}" + }, + { + "name": "A bad request was provided", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": "Added as a part of security scheme: apikey", + "key": "Finicity-App-Key", + "value": "" + } + ], + "url": { + "raw": "{{baseUrl}}/analytics/payment-history/v1/customer/:customerId?reference-number=abc123", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "analytics", + "payment-history", + "v1", + "customer", + ":customerId" + ], + "query": [ + { + "key": "reference-number", + "value": "abc123", + "description": "Partner-provided reference number to correlate reports." + } + ], + "variable": [ + { + "key": "customerId" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"errorCode\": 400,\n \"message\": \"Missing required parameter 'customerId'\"\n}" + }, + { + "name": "Unauthorized request", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": "Added as a part of security scheme: apikey", + "key": "Finicity-App-Key", + "value": "" + } + ], + "url": { + "raw": "{{baseUrl}}/analytics/payment-history/v1/customer/:customerId?reference-number=abc123", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "analytics", + "payment-history", + "v1", + "customer", + ":customerId" + ], + "query": [ + { + "key": "reference-number", + "value": "abc123", + "description": "Partner-provided reference number to correlate reports." + } + ], + "variable": [ + { + "key": "customerId" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"errorCode\": 401,\n \"message\": \"Invalid Finicity-App-Key\"\n}" + }, + { + "name": "Access forbidden", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": "Added as a part of security scheme: apikey", + "key": "Finicity-App-Key", + "value": "" + } + ], + "url": { + "raw": "{{baseUrl}}/analytics/payment-history/v1/customer/:customerId?reference-number=abc123", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "analytics", + "payment-history", + "v1", + "customer", + ":customerId" + ], + "query": [ + { + "key": "reference-number", + "value": "abc123", + "description": "Partner-provided reference number to correlate reports." + } + ], + "variable": [ + { + "key": "customerId" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"errorCode\": 403,\n \"message\": \"Partner does not have access to this resource\"\n}" + }, + { + "name": "Resource not found", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": "Added as a part of security scheme: apikey", + "key": "Finicity-App-Key", + "value": "" + } + ], + "url": { + "raw": "{{baseUrl}}/analytics/payment-history/v1/customer/:customerId?reference-number=abc123", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "analytics", + "payment-history", + "v1", + "customer", + ":customerId" + ], + "query": [ + { + "key": "reference-number", + "value": "abc123", + "description": "Partner-provided reference number to correlate reports." + } + ], + "variable": [ + { + "key": "customerId" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"errorCode\": 404,\n \"message\": \"Customer not found\"\n}" + } + ] + }, + { + "name": "Generate Payment History - FCRA", + "event": [ + { + "listen": "test", + "script": { + "exec": [ + "pm.test(\"Check status code\", function () {\r", + " pm.expect(pm.response.code).to.equals(409)\r", + " const body = pm.response.json()\r", + " pm.expect(body.errorCode).to.equals(409)\r", + " pm.expect(body.message).to.equals(\"requested customer is not registered as a business\")\r", + "})\r", + "\r", + "if (pm.response.code === 200) {\r", + " /* Store the report ID */\r", + " const reportId = pm.response.json().reportId\r", + " pm.globals.set(\"obbFcraReportId\", reportId)\r", + "}" + ], + "type": "text/javascript" + } + } + ], + "request": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json", + "type": "text" + }, + { + "key": "Content-Type", + "value": "application/json", + "type": "text" + }, + { + "key": "Finicity-App-Token", + "value": "{{appToken}}", + "type": "text" + }, + { + "key": "Finicity-App-Key", + "value": "{{appKey}}", + "type": "text" + } + ], + "url": { + "raw": "{{baseUrl}}/analytics/payment-history/v1/customer/{{customerId}}/fcra?reference-number=abc123", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "analytics", + "payment-history", + "v1", + "customer", + "{{customerId}}", + "fcra" + ], + "query": [ + { + "key": "reference-number", + "value": "abc123", + "description": "Partner-provided reference number to correlate reports." + } + ] + }, + "description": "Payment history report analyzes up to 12-months of transactions and predicts the probability that a SMB will experience a payment risk event, such as NSF/Overdraft or missed recurring payments, in the near future when making a payment. The Risk Score provided in the report is a 2-digit ranking with four levels of risk going from low to high.\n\nSome of the highlights of calculated risk present in the report include:\n* Risk Score representing the likelihood of a missed payment\n based on analysis of permissioned open-banking data\n\n* Monthly average balance for all accounts by month in the requested\n time period\n\n* Total deposit amount by month for all accounts in the requested time\n period\n\n* Total withdrawal amounts by month for all accounts in the requested\n time period\n\n* Number of NSF counts and aggregate amount per month in the requested\n time period\n\n* Recurring loan payment amounts per month in the requested time period\n* Insurance payment amount per month in the requested time period\n* Tax payment amounts per month in the requested time period\n\nThis version of the API is intended for production use. It maintains and\n enforces all compliance iwth FCRA rules and requirements.\n\n\n*Note:* this is a premium service, billable per every successful API call for non-testing customers.\n\nA successful call to this API will generate analytics and store a report within Finicity. The report can be retrieved via _Get OBB Analytics Report - FCRA_ (operation: _GetObbAnalyticsReportFcra_).\n\n_Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png)" + }, + "response": [ + { + "name": "Response given when payment history (FCRA) was generated successfully, providing the caller with a report ID which can be used to retrieve the report as JSON or a PDF.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": "Added as a part of security scheme: apikey", + "key": "Finicity-App-Key", + "value": "" + } + ], + "url": { + "raw": "{{baseUrl}}/analytics/payment-history/v1/customer/:customerId/fcra?reference-number=abc123", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "analytics", + "payment-history", + "v1", + "customer", + ":customerId", + "fcra" + ], + "query": [ + { + "key": "reference-number", + "value": "abc123", + "description": "Partner-provided reference number to correlate reports." + } + ], + "variable": [ + { + "key": "customerId" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"reportId\": \"145cabe0-2b38-4175-9b7e-115431359839\",\n \"reportPin\": \"qert\",\n \"customerId\": 10001,\n \"accountIds\": [\n 10001,\n 10002,\n 10003\n ],\n \"title\": \"Finicity Payment History\",\n \"createdDate\": \"2022-02-10T05:00:00-07:00\",\n \"businessId\": 123,\n \"requesterName\": \"Mortage ABC LLC\"\n}" + }, + { + "name": "A bad request was provided", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": "Added as a part of security scheme: apikey", + "key": "Finicity-App-Key", + "value": "" + } + ], + "url": { + "raw": "{{baseUrl}}/analytics/payment-history/v1/customer/:customerId/fcra?reference-number=abc123", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "analytics", + "payment-history", + "v1", + "customer", + ":customerId", + "fcra" + ], + "query": [ + { + "key": "reference-number", + "value": "abc123", + "description": "Partner-provided reference number to correlate reports." + } + ], + "variable": [ + { + "key": "customerId" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"errorCode\": 400,\n \"message\": \"Missing required parameter 'customerId'\"\n}" + }, + { + "name": "Unauthorized request", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": "Added as a part of security scheme: apikey", + "key": "Finicity-App-Key", + "value": "" + } + ], + "url": { + "raw": "{{baseUrl}}/analytics/payment-history/v1/customer/:customerId/fcra?reference-number=abc123", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "analytics", + "payment-history", + "v1", + "customer", + ":customerId", + "fcra" + ], + "query": [ + { + "key": "reference-number", + "value": "abc123", + "description": "Partner-provided reference number to correlate reports." + } + ], + "variable": [ + { + "key": "customerId" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"errorCode\": 401,\n \"message\": \"Invalid Finicity-App-Key\"\n}" + }, + { + "name": "Access forbidden", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": "Added as a part of security scheme: apikey", + "key": "Finicity-App-Key", + "value": "" + } + ], + "url": { + "raw": "{{baseUrl}}/analytics/payment-history/v1/customer/:customerId/fcra?reference-number=abc123", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "analytics", + "payment-history", + "v1", + "customer", + ":customerId", + "fcra" + ], + "query": [ + { + "key": "reference-number", + "value": "abc123", + "description": "Partner-provided reference number to correlate reports." + } + ], + "variable": [ + { + "key": "customerId" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"errorCode\": 403,\n \"message\": \"Partner does not have access to this resource\"\n}" + }, + { + "name": "Resource not found", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": "Added as a part of security scheme: apikey", + "key": "Finicity-App-Key", + "value": "" + } + ], + "url": { + "raw": "{{baseUrl}}/analytics/payment-history/v1/customer/:customerId/fcra?reference-number=abc123", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "analytics", + "payment-history", + "v1", + "customer", + ":customerId", + "fcra" + ], + "query": [ + { + "key": "reference-number", + "value": "abc123", + "description": "Partner-provided reference number to correlate reports." + } + ], + "variable": [ + { + "key": "customerId" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"errorCode\": 404,\n \"message\": \"Customer not found\"\n}" + }, + { + "name": "Resource conflict", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": "Added as a part of security scheme: apikey", + "key": "Finicity-App-Key", + "value": "" + } + ], + "url": { + "raw": "{{baseUrl}}/analytics/payment-history/v1/customer/:customerId/fcra?reference-number=abc123", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "analytics", + "payment-history", + "v1", + "customer", + ":customerId", + "fcra" + ], + "query": [ + { + "key": "reference-number", + "value": "abc123", + "description": "Partner-provided reference number to correlate reports." + } + ], + "variable": [ + { + "key": "customerId" + } + ] + } + }, + "status": "Conflict", + "code": 409, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"errorCode\": 409,\n \"message\": \"Customer is not registered as a business\"\n}" + } + ] + }, + { + "name": "Get OBB Analytics Report", + "event": [ + { + "listen": "test", + "script": { + "exec": [ + "pm.test(\"Check status code\", function () {\r", + " pm.expect(pm.response.code).to.equals(200)\r", + "})" + ], + "type": "text/javascript" + } + } + ], + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "type": "text" + }, + { + "key": "Finicity-App-Token", + "value": "{{appToken}}", + "type": "text" + }, + { + "key": "Finicity-App-Key", + "value": "{{appKey}}", + "type": "text" + } + ], + "url": { + "raw": "{{baseUrl}}/analytics/data/v1/{{obbReportId}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "analytics", + "data", + "v1", + "{{obbReportId}}" + ] + }, + "description": "Retrieve the report saved by _Generate Balance Analytics_, _Generate Cash Flow Analytics_, or _Generate Payment History_. Requires the report ID generated by the previous call.\n\nReport data can either be retrieved as a JSON document or PDF file.\n\n_Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png)" + }, + "response": [ + { + "name": "OBB Analytics report data as JSON or PDF", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": "Added as a part of security scheme: apikey", + "key": "Finicity-App-Key", + "value": "" + } + ], + "url": { + "raw": "{{baseUrl}}/analytics/data/v1/:obb_report_id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "analytics", + "data", + "v1", + ":obb_report_id" + ], + "variable": [ + { + "key": "obb_report_id" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"accountResults\": [\n {\n \"accountDetails\": {\n \"accountNumberDisplay\": \"8888\",\n \"accountOwner\": {\n \"address\": \"123 Main St, Portland, OR 12345\",\n \"name\": \"Johnny Appleseed\"\n },\n \"aggregationAttemptDate\": \"2022-03-30T14:47:19-07:00\",\n \"aggregationStatusCode\": 0,\n \"aggregationSuccessDate\": \"2022-03-30T14:47:19-07:00\",\n \"currency\": \"USD\",\n \"currentBalance\": 2239.22,\n \"id\": \"1234902309er\",\n \"institution\": {\n \"institutionIconUrl\": \"https://prod-carpintero-branding.s3.us-west-2.amazonaws.com/101732/icon.svg\",\n \"institutionId\": 12345,\n \"institutionName\": \"Wells Fargo\",\n \"institutionPrimaryColor\": \"#1B3E4A\"\n },\n \"institutionLoginId\": 1007302745,\n \"name\": \"Super Checking\",\n \"realAccountNumberLast4\": 5678,\n \"status\": \"active\",\n \"type\": \"checking\"\n },\n \"accountId\": 5001127492,\n \"balanceAnalyticsMetrics\": {\n \"availableBalance\": {\n \"description\": \"Available Balance\",\n \"example\": 1000.01,\n \"type\": \"number\"\n },\n \"availableBalanceDate\": {\n \"description\": \"Available Balance date\",\n \"example\": \"2022-02-18T02:34:00-07:00\",\n \"type\": \"string\",\n \"minLength\": 25,\n \"maxLength\": 25\n },\n \"averageDailyBalanceByMonthForTheReportTimePeriod\": [\n {\n \"amount\": 890.99,\n \"period\": \"last30to1\",\n \"periodBeginDate\": \"2022-03-01\",\n \"periodEndDate\": \"2022-03-30\"\n }\n ],\n \"averageDailyBalanceForTheReportTimePeriod\": {\n \"description\": \"Average Daily Balance\",\n \"example\": -10442.53,\n \"type\": \"number\"\n },\n \"averageWeekdayBalanceForTheReportTimePeriod\": {\n \"description\": \"Average Weekday Balance\",\n \"example\": -10442.53,\n \"type\": \"number\"\n },\n \"countDailyNegativeBalancesByMonthForTheReportTimePeriod\": [\n {\n \"count\": 5,\n \"period\": \"last30to1\",\n \"periodBeginDate\": \"2022-03-01\",\n \"periodEndDate\": \"2022-03-30\"\n }\n ],\n \"currentRunningBalance\": {\n \"description\": \"Current Running Balance Date\",\n \"example\": 1000.01,\n \"type\": \"number\"\n },\n \"currentRunningBalanceDate\": {\n \"description\": \"Current Running Balance date\",\n \"example\": \"2022-02-10T05:00:00-07:00\",\n \"type\": \"string\",\n \"minLength\": 25,\n \"maxLength\": 25\n },\n \"dailyBalancesByWeekdayForTheReportTimePeriod\": [\n {\n \"date\": \"2021-10-11\",\n \"dayOfWeek\": \"Monday\",\n \"endingBalance\": 21527.3\n }\n ],\n \"dailyBalancesForTheReportTimePeriod\": [\n {\n \"date\": \"2021-10-11\",\n \"dayOfWeek\": \"Monday\",\n \"endingBalance\": 21527.3\n }\n ],\n \"historicNumberOfWeeksAverageBalanceIncreasing\": {\n \"historicAverageWeeklyBalances\": [\n {\n \"amount\": 679.07,\n \"fromDate\": \"2020-01-01\",\n \"toDate\": \"2020-01-07\",\n \"week\": 1\n }\n ],\n \"historicNumberOfWeeksAverageBalanceIncreasing\": 3,\n \"historicNumberOfWeeksWithDataAvailable\": 4\n },\n \"maximumDailyBalanceByMonthForTheReportTimePeriod\": [\n {\n \"amount\": 890.99,\n \"period\": \"last30to1\",\n \"periodBeginDate\": \"2022-03-01\",\n \"periodEndDate\": \"2022-03-30\"\n }\n ],\n \"maximumRunningBalanceForTheReportTimePeriod\": -28749.44,\n \"minimumDailyBalanceByMonthForTheReportTimePeriod\": [\n {\n \"amount\": 890.99,\n \"period\": \"last30to1\",\n \"periodBeginDate\": \"2022-03-01\",\n \"periodEndDate\": \"2022-03-30\"\n }\n ],\n \"minimumRunningBalanceForTheReportTimePeriod\": -28749.44\n },\n \"currentReportRequest\": {\n \"reportBeginDate\": \"2022-03-01\",\n \"reportEndDate\": \"2022-03-30\",\n \"reportRequestDate\": \"2022-03-30T14:47:19-07:00\",\n \"requestedDaysForReport\": 90,\n \"requestedReportBeginDate\": \"2022-01-01\"\n },\n \"historicDataAvailability\": {\n \"historicAvailabilityBeginDate\": \"2022-03-01\",\n \"historicAvailabilityEndDate\": \"2022-03-30\",\n \"historicAvailableDays\": 30,\n \"historicDataAvailability\": \"Data is available from 2022-03-01 to 2022-03-30\"\n }\n }\n ],\n \"businessId\": 4444,\n \"businessSummary\": {\n \"balanceAnalyticsMetrics\": {\n \"availableBalance\": {\n \"description\": \"Available Balance\",\n \"example\": 1000.01,\n \"type\": \"number\"\n },\n \"availableBalanceDate\": {\n \"description\": \"Available Balance date\",\n \"example\": \"2022-02-18T02:34:00-07:00\",\n \"type\": \"string\",\n \"minLength\": 25,\n \"maxLength\": 25\n },\n \"averageDailyBalanceByMonthForTheReportTimePeriod\": [\n {\n \"amount\": 890.99,\n \"period\": \"last30to1\",\n \"periodBeginDate\": \"2022-03-01\",\n \"periodEndDate\": \"2022-03-30\"\n }\n ],\n \"averageDailyBalanceForTheReportTimePeriod\": {\n \"description\": \"Average Daily Balance\",\n \"example\": -10442.53,\n \"type\": \"number\"\n },\n \"averageWeekdayBalanceForTheReportTimePeriod\": {\n \"description\": \"Average Weekday Balance\",\n \"example\": -10442.53,\n \"type\": \"number\"\n },\n \"countDailyNegativeBalancesByMonthForTheReportTimePeriod\": [\n {\n \"count\": 5,\n \"period\": \"last30to1\",\n \"periodBeginDate\": \"2022-03-01\",\n \"periodEndDate\": \"2022-03-30\"\n }\n ],\n \"currentRunningBalance\": {\n \"description\": \"Current Running Balance Date\",\n \"example\": 1000.01,\n \"type\": \"number\"\n },\n \"currentRunningBalanceDate\": {\n \"description\": \"Current Running Balance date\",\n \"example\": \"2022-02-10T05:00:00-07:00\",\n \"type\": \"string\",\n \"minLength\": 25,\n \"maxLength\": 25\n },\n \"dailyBalancesByWeekdayForTheReportTimePeriod\": [\n {\n \"date\": \"2021-10-11\",\n \"dayOfWeek\": \"Monday\",\n \"endingBalance\": 21527.3\n }\n ],\n \"dailyBalancesForTheReportTimePeriod\": [\n {\n \"date\": \"2021-10-11\",\n \"dayOfWeek\": \"Monday\",\n \"endingBalance\": 21527.3\n }\n ],\n \"historicNumberOfWeeksAverageBalanceIncreasing\": {\n \"historicAverageWeeklyBalances\": [\n {\n \"amount\": 679.07,\n \"fromDate\": \"2020-01-01\",\n \"toDate\": \"2020-01-07\",\n \"week\": 1\n }\n ],\n \"historicNumberOfWeeksAverageBalanceIncreasing\": 3,\n \"historicNumberOfWeeksWithDataAvailable\": 4\n },\n \"maximumDailyBalanceByMonthForTheReportTimePeriod\": [\n {\n \"amount\": 890.99,\n \"period\": \"last30to1\",\n \"periodBeginDate\": \"2022-03-01\",\n \"periodEndDate\": \"2022-03-30\"\n }\n ],\n \"maximumRunningBalanceForTheReportTimePeriod\": -28749.44,\n \"minimumDailyBalanceByMonthForTheReportTimePeriod\": [\n {\n \"amount\": 890.99,\n \"period\": \"last30to1\",\n \"periodBeginDate\": \"2022-03-01\",\n \"periodEndDate\": \"2022-03-30\"\n }\n ],\n \"minimumRunningBalanceForTheReportTimePeriod\": -28749.44\n },\n \"currentReportRequest\": {\n \"reportBeginDate\": \"2022-03-01\",\n \"reportEndDate\": \"2022-03-30\",\n \"reportRequestDate\": \"2022-03-30T14:47:19-07:00\",\n \"requestedDaysForReport\": 90,\n \"requestedReportBeginDate\": \"2022-01-01\"\n },\n \"historicDataAvailability\": {\n \"historicAvailabilityBeginDate\": \"2022-03-01\",\n \"historicAvailabilityEndDate\": \"2022-03-30\",\n \"historicAvailableDays\": 30,\n \"historicDataAvailability\": \"Data is available from 2022-03-01 to 2022-03-30\"\n }\n },\n \"customerId\": 10001,\n \"reportHeader\": {\n \"businessAddress\": \"123 Main St\",\n \"businessCity\": \"Portland\",\n \"businessName\": \"B&G Construction\",\n \"businessState\": \"OR\",\n \"businessZip\": \"12345\",\n \"referenceNumber\": \"32asdfaasd0823\",\n \"reportDate\": \"2022-03-16T21:28:38-07:00\",\n \"reportId\": \"8ff8b4b2-706f-45c3-8d66-857bdb516214\"\n },\n \"requesterName\": \"Mortgage ABC LLC\",\n \"title\": \"Fincity Balance Analytics\"\n}" + }, + { + "name": "Unauthorized request", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": "Added as a part of security scheme: apikey", + "key": "Finicity-App-Key", + "value": "" + } + ], + "url": { + "raw": "{{baseUrl}}/analytics/data/v1/:obb_report_id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "analytics", + "data", + "v1", + ":obb_report_id" + ], + "variable": [ + { + "key": "obb_report_id" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"errorCode\": 401,\n \"message\": \"Invalid Finicity-App-Key\"\n}" + }, + { + "name": "Access forbidden", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": "Added as a part of security scheme: apikey", + "key": "Finicity-App-Key", + "value": "" + } + ], + "url": { + "raw": "{{baseUrl}}/analytics/data/v1/:obb_report_id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "analytics", + "data", + "v1", + ":obb_report_id" + ], + "variable": [ + { + "key": "obb_report_id" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"errorCode\": 403,\n \"message\": \"Partner does not have access to this resource\"\n}" }, { "name": "The resource doesn't exist", "originalRequest": { "method": "GET", "header": [ + { + "key": "Accept", + "value": "application/json" + }, { "description": "Added as a part of security scheme: apikey", "key": "Finicity-App-Key", - "value": "{{appKey}}" + "value": "" } ], "url": { - "raw": "{{baseUrl}}/aggregation/v1/customers/:customerId/accounts/:accountId/availableBalance/live", + "raw": "{{baseUrl}}/analytics/data/v1/:obb_report_id", "host": [ "{{baseUrl}}" ], "path": [ - "aggregation", + "analytics", + "data", "v1", - "customers", - ":customerId", - "accounts", - ":accountId", - "availableBalance", - "live" + ":obb_report_id" ], "variable": [ { - "key": "customerId", - "value": "1005061234", - "description": "(Required) A customer ID" - }, - { - "key": "accountId", - "value": "5011648377", - "description": "(Required) The account ID" + "key": "obb_report_id" } ] } @@ -16206,97 +17880,90 @@ } ], "cookie": [], - "body": "{\n \"code\": 10100,\n \"message\": \"Cannot find consumer with id 1234.\"\n}" + "body": "{\n \"code\": 10100,\n \"message\": \"Cannot find consumer with id 1234.\"\n}" } ] }, { - "name": "Get Available Balance", - "event": [ - { - "listen": "test", - "script": { - "exec": [ - "pm.test(\"Check status code\", function () {\r", - " pm.expect(pm.response.code).to.equals(200)\r", - "})" - ], - "type": "text/javascript" - } - } - ], + "name": "Get OBB Analytics Report - FCRA", "request": { "method": "GET", "header": [ - { - "key": "Finicity-App-Key", - "value": "{{appKey}}", - "type": "text" - }, { "key": "Accept", - "value": "application/json", - "type": "text" + "value": "application/json" }, { "key": "Finicity-App-Token", "value": "{{appToken}}", "type": "text" + }, + { + "key": "Finicity-App-Key", + "value": "{{appKey}}", + "type": "text" } ], "url": { - "raw": "{{baseUrl}}/aggregation/v1/customers/{{customerId}}/accounts/{{savingAccountId}}/availableBalance", + "raw": "{{baseUrl}}/analytics/data/v1/{{obbFcraReportId}}/fcra?purpose=31", "host": [ "{{baseUrl}}" ], "path": [ - "aggregation", + "analytics", + "data", "v1", - "customers", - "{{customerId}}", - "accounts", - "{{savingAccountId}}", - "availableBalance" + "{{obbFcraReportId}}", + "fcra" + ], + "query": [ + { + "key": "purpose", + "value": "31", + "description": "(Required) 2-digit code from [Permissible Purpose Codes](https://docs.finicity.com/permissible-purpose-codes/), specifying the reason for retrieving this report. Required for retrieving some reports." + } ] }, - "description": "Retrieve the latest cached available and cleared account balances for a customer. Since we update and store balances throughout the day, this is the most accurate balance information available when a connection to a financial institution is unavailable or when a faster response is needed. Only deposit account types are supported: Checking, Savings, Money Market, and CD.\n\nNote: this is a premium service, billable per every successful API call. Enrollment is required.\n\n_Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png)" + "description": "Retrieve the report saved by _Generate Balance Analytics - FCRA_, _Generate Cash Flow Analytics - FCRA_, or _Generate Payment History - FCRA_. Requires the report ID generated by the previous call.\n\nReport data can either be retrieved as a JSON document or PDF file.\n\n_Note:_ this is a premium service, billable per every successful API call for non-testing customers.\n\n_Supported regions_:\n\n\"🇺🇸\"" }, "response": [ { - "name": "The balance was successfully retrieved", + "name": "OBB Analytics FCRA report data as JSON or PDF", "originalRequest": { "method": "GET", "header": [ + { + "key": "Accept", + "value": "application/json" + }, { "description": "Added as a part of security scheme: apikey", "key": "Finicity-App-Key", - "value": "{{appKey}}" + "value": "" } ], "url": { - "raw": "{{baseUrl}}/aggregation/v1/customers/:customerId/accounts/:accountId/availableBalance", + "raw": "{{baseUrl}}/analytics/data/v1/:obb_report_id/fcra?purpose=31", "host": [ "{{baseUrl}}" ], "path": [ - "aggregation", + "analytics", + "data", "v1", - "customers", - ":customerId", - "accounts", - ":accountId", - "availableBalance" + ":obb_report_id", + "fcra" ], - "variable": [ + "query": [ { - "key": "customerId", - "value": "1005061234", - "description": "(Required) A customer ID" - }, + "key": "purpose", + "value": "31", + "description": "(Required) 2-digit code from [Permissible Purpose Codes](https://docs.finicity.com/permissible-purpose-codes/), specifying the reason for retrieving this report. Required for retrieving some reports." + } + ], + "variable": [ { - "key": "accountId", - "value": "5011648377", - "description": "(Required) The account ID" + "key": "obb_report_id" } ] } @@ -16311,49 +17978,51 @@ } ], "cookie": [], - "body": "{}" + "body": "{\n \"accountResults\": [\n {\n \"accountDetails\": {\n \"accountNumberDisplay\": \"8888\",\n \"accountOwner\": {\n \"address\": \"123 Main St, Portland, OR 12345\",\n \"name\": \"Johnny Appleseed\"\n },\n \"aggregationAttemptDate\": \"2022-03-30T14:47:19-07:00\",\n \"aggregationStatusCode\": 0,\n \"aggregationSuccessDate\": \"2022-03-30T14:47:19-07:00\",\n \"currency\": \"USD\",\n \"currentBalance\": 2239.22,\n \"id\": \"1234902309er\",\n \"institution\": {\n \"institutionIconUrl\": \"https://prod-carpintero-branding.s3.us-west-2.amazonaws.com/101732/icon.svg\",\n \"institutionId\": 12345,\n \"institutionName\": \"Wells Fargo\",\n \"institutionPrimaryColor\": \"#1B3E4A\"\n },\n \"institutionLoginId\": 1007302745,\n \"name\": \"Super Checking\",\n \"realAccountNumberLast4\": 5678,\n \"status\": \"active\",\n \"type\": \"checking\"\n },\n \"accountId\": 5001127492,\n \"balanceAnalyticsMetrics\": {\n \"availableBalance\": {\n \"description\": \"Available Balance\",\n \"example\": 1000.01,\n \"type\": \"number\"\n },\n \"availableBalanceDate\": {\n \"description\": \"Available Balance date\",\n \"example\": \"2022-02-18T02:34:00-07:00\",\n \"type\": \"string\",\n \"minLength\": 25,\n \"maxLength\": 25\n },\n \"averageDailyBalanceByMonthForTheReportTimePeriod\": [\n {\n \"amount\": 890.99,\n \"period\": \"last30to1\",\n \"periodBeginDate\": \"2022-03-01\",\n \"periodEndDate\": \"2022-03-30\"\n }\n ],\n \"averageDailyBalanceForTheReportTimePeriod\": {\n \"description\": \"Average Daily Balance\",\n \"example\": -10442.53,\n \"type\": \"number\"\n },\n \"averageWeekdayBalanceForTheReportTimePeriod\": {\n \"description\": \"Average Weekday Balance\",\n \"example\": -10442.53,\n \"type\": \"number\"\n },\n \"countDailyNegativeBalancesByMonthForTheReportTimePeriod\": [\n {\n \"count\": 5,\n \"period\": \"last30to1\",\n \"periodBeginDate\": \"2022-03-01\",\n \"periodEndDate\": \"2022-03-30\"\n }\n ],\n \"currentRunningBalance\": {\n \"description\": \"Current Running Balance Date\",\n \"example\": 1000.01,\n \"type\": \"number\"\n },\n \"currentRunningBalanceDate\": {\n \"description\": \"Current Running Balance date\",\n \"example\": \"2022-02-10T05:00:00-07:00\",\n \"type\": \"string\",\n \"minLength\": 25,\n \"maxLength\": 25\n },\n \"dailyBalancesByWeekdayForTheReportTimePeriod\": [\n {\n \"date\": \"2021-10-11\",\n \"dayOfWeek\": \"Monday\",\n \"endingBalance\": 21527.3\n }\n ],\n \"dailyBalancesForTheReportTimePeriod\": [\n {\n \"date\": \"2021-10-11\",\n \"dayOfWeek\": \"Monday\",\n \"endingBalance\": 21527.3\n }\n ],\n \"historicNumberOfWeeksAverageBalanceIncreasing\": {\n \"historicAverageWeeklyBalances\": [\n {\n \"amount\": 679.07,\n \"fromDate\": \"2020-01-01\",\n \"toDate\": \"2020-01-07\",\n \"week\": 1\n }\n ],\n \"historicNumberOfWeeksAverageBalanceIncreasing\": 3,\n \"historicNumberOfWeeksWithDataAvailable\": 4\n },\n \"maximumDailyBalanceByMonthForTheReportTimePeriod\": [\n {\n \"amount\": 890.99,\n \"period\": \"last30to1\",\n \"periodBeginDate\": \"2022-03-01\",\n \"periodEndDate\": \"2022-03-30\"\n }\n ],\n \"maximumRunningBalanceForTheReportTimePeriod\": -28749.44,\n \"minimumDailyBalanceByMonthForTheReportTimePeriod\": [\n {\n \"amount\": 890.99,\n \"period\": \"last30to1\",\n \"periodBeginDate\": \"2022-03-01\",\n \"periodEndDate\": \"2022-03-30\"\n }\n ],\n \"minimumRunningBalanceForTheReportTimePeriod\": -28749.44\n },\n \"currentReportRequest\": {\n \"reportBeginDate\": \"2022-03-01\",\n \"reportEndDate\": \"2022-03-30\",\n \"reportRequestDate\": \"2022-03-30T14:47:19-07:00\",\n \"requestedDaysForReport\": 90,\n \"requestedReportBeginDate\": \"2022-01-01\"\n },\n \"historicDataAvailability\": {\n \"historicAvailabilityBeginDate\": \"2022-03-01\",\n \"historicAvailabilityEndDate\": \"2022-03-30\",\n \"historicAvailableDays\": 30,\n \"historicDataAvailability\": \"Data is available from 2022-03-01 to 2022-03-30\"\n }\n }\n ],\n \"businessId\": 4444,\n \"businessSummary\": {\n \"balanceAnalyticsMetrics\": {\n \"availableBalance\": {\n \"description\": \"Available Balance\",\n \"example\": 1000.01,\n \"type\": \"number\"\n },\n \"availableBalanceDate\": {\n \"description\": \"Available Balance date\",\n \"example\": \"2022-02-18T02:34:00-07:00\",\n \"type\": \"string\",\n \"minLength\": 25,\n \"maxLength\": 25\n },\n \"averageDailyBalanceByMonthForTheReportTimePeriod\": [\n {\n \"amount\": 890.99,\n \"period\": \"last30to1\",\n \"periodBeginDate\": \"2022-03-01\",\n \"periodEndDate\": \"2022-03-30\"\n }\n ],\n \"averageDailyBalanceForTheReportTimePeriod\": {\n \"description\": \"Average Daily Balance\",\n \"example\": -10442.53,\n \"type\": \"number\"\n },\n \"averageWeekdayBalanceForTheReportTimePeriod\": {\n \"description\": \"Average Weekday Balance\",\n \"example\": -10442.53,\n \"type\": \"number\"\n },\n \"countDailyNegativeBalancesByMonthForTheReportTimePeriod\": [\n {\n \"count\": 5,\n \"period\": \"last30to1\",\n \"periodBeginDate\": \"2022-03-01\",\n \"periodEndDate\": \"2022-03-30\"\n }\n ],\n \"currentRunningBalance\": {\n \"description\": \"Current Running Balance Date\",\n \"example\": 1000.01,\n \"type\": \"number\"\n },\n \"currentRunningBalanceDate\": {\n \"description\": \"Current Running Balance date\",\n \"example\": \"2022-02-10T05:00:00-07:00\",\n \"type\": \"string\",\n \"minLength\": 25,\n \"maxLength\": 25\n },\n \"dailyBalancesByWeekdayForTheReportTimePeriod\": [\n {\n \"date\": \"2021-10-11\",\n \"dayOfWeek\": \"Monday\",\n \"endingBalance\": 21527.3\n }\n ],\n \"dailyBalancesForTheReportTimePeriod\": [\n {\n \"date\": \"2021-10-11\",\n \"dayOfWeek\": \"Monday\",\n \"endingBalance\": 21527.3\n }\n ],\n \"historicNumberOfWeeksAverageBalanceIncreasing\": {\n \"historicAverageWeeklyBalances\": [\n {\n \"amount\": 679.07,\n \"fromDate\": \"2020-01-01\",\n \"toDate\": \"2020-01-07\",\n \"week\": 1\n }\n ],\n \"historicNumberOfWeeksAverageBalanceIncreasing\": 3,\n \"historicNumberOfWeeksWithDataAvailable\": 4\n },\n \"maximumDailyBalanceByMonthForTheReportTimePeriod\": [\n {\n \"amount\": 890.99,\n \"period\": \"last30to1\",\n \"periodBeginDate\": \"2022-03-01\",\n \"periodEndDate\": \"2022-03-30\"\n }\n ],\n \"maximumRunningBalanceForTheReportTimePeriod\": -28749.44,\n \"minimumDailyBalanceByMonthForTheReportTimePeriod\": [\n {\n \"amount\": 890.99,\n \"period\": \"last30to1\",\n \"periodBeginDate\": \"2022-03-01\",\n \"periodEndDate\": \"2022-03-30\"\n }\n ],\n \"minimumRunningBalanceForTheReportTimePeriod\": -28749.44\n },\n \"currentReportRequest\": {\n \"reportBeginDate\": \"2022-03-01\",\n \"reportEndDate\": \"2022-03-30\",\n \"reportRequestDate\": \"2022-03-30T14:47:19-07:00\",\n \"requestedDaysForReport\": 90,\n \"requestedReportBeginDate\": \"2022-01-01\"\n },\n \"historicDataAvailability\": {\n \"historicAvailabilityBeginDate\": \"2022-03-01\",\n \"historicAvailabilityEndDate\": \"2022-03-30\",\n \"historicAvailableDays\": 30,\n \"historicDataAvailability\": \"Data is available from 2022-03-01 to 2022-03-30\"\n }\n },\n \"customerId\": 10001,\n \"reportHeader\": {\n \"businessAddress\": \"123 Main St\",\n \"businessCity\": \"Portland\",\n \"businessName\": \"B&G Construction\",\n \"businessState\": \"OR\",\n \"businessZip\": \"12345\",\n \"referenceNumber\": \"32asdfaasd0823\",\n \"reportDate\": \"2022-03-16T21:28:38-07:00\",\n \"reportId\": \"8ff8b4b2-706f-45c3-8d66-857bdb516214\"\n },\n \"requesterName\": \"Mortgage ABC LLC\",\n \"title\": \"Fincity Balance Analytics\"\n}" }, { - "name": "The request was rejected", + "name": "Unauthorized request", "originalRequest": { "method": "GET", "header": [ + { + "key": "Accept", + "value": "application/json" + }, { "description": "Added as a part of security scheme: apikey", "key": "Finicity-App-Key", - "value": "{{appKey}}" + "value": "" } ], "url": { - "raw": "{{baseUrl}}/aggregation/v1/customers/:customerId/accounts/:accountId/availableBalance", + "raw": "{{baseUrl}}/analytics/data/v1/:obb_report_id/fcra?purpose=31", "host": [ "{{baseUrl}}" ], "path": [ - "aggregation", + "analytics", + "data", "v1", - "customers", - ":customerId", - "accounts", - ":accountId", - "availableBalance" + ":obb_report_id", + "fcra" ], - "variable": [ + "query": [ { - "key": "customerId", - "value": "1005061234", - "description": "(Required) A customer ID" - }, + "key": "purpose", + "value": "31", + "description": "(Required) 2-digit code from [Permissible Purpose Codes](https://docs.finicity.com/permissible-purpose-codes/), specifying the reason for retrieving this report. Required for retrieving some reports." + } + ], + "variable": [ { - "key": "accountId", - "value": "5011648377", - "description": "(Required) The account ID" + "key": "obb_report_id" } ] } }, - "status": "Bad Request", - "code": 400, + "status": "Unauthorized", + "code": 401, "_postman_previewlanguage": "json", "header": [ { @@ -16362,49 +18031,51 @@ } ], "cookie": [], - "body": "{\n \"code\": \"10010\",\n \"status\": \"400\",\n \"message\": \"\\\"partnerId\\\" is required\",\n \"user_message\": \"One or more of the fields could not be validated. Please ensure you have entered the correct data.\",\n \"tags\": \"\"\n}" + "body": "{\n \"errorCode\": 401,\n \"message\": \"Invalid Finicity-App-Key\"\n}" }, { - "name": "The request lacks valid authentication credentials. Check \"Finicity-App-Key\" or \"Finicity-App-Token\".", + "name": "Access forbidden", "originalRequest": { "method": "GET", "header": [ + { + "key": "Accept", + "value": "application/json" + }, { "description": "Added as a part of security scheme: apikey", "key": "Finicity-App-Key", - "value": "{{appKey}}" + "value": "" } ], "url": { - "raw": "{{baseUrl}}/aggregation/v1/customers/:customerId/accounts/:accountId/availableBalance", + "raw": "{{baseUrl}}/analytics/data/v1/:obb_report_id/fcra?purpose=31", "host": [ "{{baseUrl}}" ], "path": [ - "aggregation", + "analytics", + "data", "v1", - "customers", - ":customerId", - "accounts", - ":accountId", - "availableBalance" + ":obb_report_id", + "fcra" ], - "variable": [ + "query": [ { - "key": "customerId", - "value": "1005061234", - "description": "(Required) A customer ID" - }, + "key": "purpose", + "value": "31", + "description": "(Required) 2-digit code from [Permissible Purpose Codes](https://docs.finicity.com/permissible-purpose-codes/), specifying the reason for retrieving this report. Required for retrieving some reports." + } + ], + "variable": [ { - "key": "accountId", - "value": "5011648377", - "description": "(Required) The account ID" + "key": "obb_report_id" } ] } }, - "status": "Unauthorized", - "code": 401, + "status": "Forbidden", + "code": 403, "_postman_previewlanguage": "json", "header": [ { @@ -16413,43 +18084,45 @@ } ], "cookie": [], - "body": "{\n \"code\": \"10022\",\n \"status\": \"401\",\n \"message\": \"Invalid authorization credentials\",\n \"user_message\": \"The session has expired or is invalid\",\n \"tags\": \"\"\n}" + "body": "{\n \"errorCode\": 403,\n \"message\": \"Partner does not have access to this resource\"\n}" }, { "name": "The resource doesn't exist", "originalRequest": { "method": "GET", "header": [ + { + "key": "Accept", + "value": "application/json" + }, { "description": "Added as a part of security scheme: apikey", "key": "Finicity-App-Key", - "value": "{{appKey}}" + "value": "" } ], "url": { - "raw": "{{baseUrl}}/aggregation/v1/customers/:customerId/accounts/:accountId/availableBalance", + "raw": "{{baseUrl}}/analytics/data/v1/:obb_report_id/fcra?purpose=31", "host": [ "{{baseUrl}}" ], "path": [ - "aggregation", + "analytics", + "data", "v1", - "customers", - ":customerId", - "accounts", - ":accountId", - "availableBalance" + ":obb_report_id", + "fcra" ], - "variable": [ + "query": [ { - "key": "customerId", - "value": "1005061234", - "description": "(Required) A customer ID" - }, + "key": "purpose", + "value": "31", + "description": "(Required) 2-digit code from [Permissible Purpose Codes](https://docs.finicity.com/permissible-purpose-codes/), specifying the reason for retrieving this report. Required for retrieving some reports." + } + ], + "variable": [ { - "key": "accountId", - "value": "5011648377", - "description": "(Required) The account ID" + "key": "obb_report_id" } ] } @@ -16464,51 +18137,12 @@ } ], "cookie": [], - "body": "{\n \"code\": 10100,\n \"message\": \"Cannot find consumer with id 1234.\"\n}" + "body": "{\n \"code\": 10100,\n \"message\": \"Cannot find consumer with id 1234.\"\n}" } ] } ], - "description": "Fetch ACH details and account balances", - "event": [ - { - "listen": "prerequest", - "script": { - "type": "text/javascript", - "exec": [ - "const baseUrl = pm.collectionVariables.get(\"baseUrl\")", - "const appKey = pm.environment.get(\"appKey\")", - "const customerId = pm.environment.get(\"customerId\")", - "const appToken = pm.globals.get(\"appToken\")", - "", - "const savingAccountId = pm.variables.get(\"savingAccountId\")", - "const accountId = pm.variables.get(\"accountId\")", - "if (savingAccountId && accountId) {", - " return", - "}", - "", - "console.log(\"Fetching account IDs\")", - "const options = {", - " url: baseUrl + \"/aggregation/v1/customers/\"+ customerId + \"/accounts\",", - " method: 'GET',", - " header: {", - " \"Accept\": \"application/json\",", - " \"Finicity-App-Key\": appKey,", - " \"Finicity-App-Token\": appToken", - " }", - "}", - "pm.sendRequest(options, function (err, response) {", - " pm.expect(err).to.be.null", - " pm.expect(response.code).to.equals(200)", - " const accounts = response.json().accounts;", - " const account = accounts.filter(a => a.type === \"savings\")[0]", - " pm.variables.set(\"savingAccountId\", account.id)", - " pm.variables.set(\"accountId\", accounts[0].id)", - "})" - ] - } - } - ] + "description": "Payment History for business" }, { "name": "Portfolios", @@ -20636,7 +22270,7 @@ }, "response": [ { - "name": "The report is being generated. When finished, a notification will be sent to the specified callback URL (Report Listener Service) and the report can be fetched using Get Report APIs. If you don't use a callback URL, Get Report returns a minimal report with the following status: 'inProgress'. Repeat the call every 20 seconds until Get Report returns a different status.", + "name": "The report is being generated. When finished, a notification will be sent to the specified callback URL (Report Listener Service) and the report can be fetched using Get Report APIs. If you don't use a callback URL, Get Report returns a minimal report wit", "originalRequest": { "method": "POST", "header": [ @@ -22100,7 +23734,7 @@ }, "response": [ { - "name": "The report is being generated. When finished, a notification will be sent to the specified callback URL (Report Listener Service) and the report can be fetched using Get Report APIs. If you don't use a callback URL, Get Report returns a minimal report with the following status: 'inProgress'. Repeat the call every 20 seconds until Get Report returns a different status.", + "name": "The report is being generated. When finished, a notification will be sent to the specified callback URL (Report Listener Service) and the report can be fetched using Get Report APIs. If you don't use a callback URL, Get Report returns a minimal report wit", "originalRequest": { "method": "POST", "header": [ @@ -22374,7 +24008,7 @@ }, "response": [ { - "name": "The report is being generated. When finished, a notification will be sent to the specified callback URL (Report Listener Service) and the report can be fetched using Get Report APIs. If you don't use a callback URL, Get Report returns a minimal report with the following status: 'inProgress'. Repeat the call every 20 seconds until Get Report returns a different status.", + "name": "The report is being generated. When finished, a notification will be sent to the specified callback URL (Report Listener Service) and the report can be fetched using Get Report APIs. If you don't use a callback URL, Get Report returns a minimal report wit", "originalRequest": { "method": "POST", "header": [ @@ -22648,7 +24282,7 @@ }, "response": [ { - "name": "The report is being generated. When finished, a notification will be sent to the specified callback URL (Report Listener Service) and the report can be fetched using Get Report APIs. If you don't use a callback URL, Get Report returns a minimal report with the following status: 'inProgress'. Repeat the call every 20 seconds until Get Report returns a different status.", + "name": "The report is being generated. When finished, a notification will be sent to the specified callback URL (Report Listener Service) and the report can be fetched using Get Report APIs. If you don't use a callback URL, Get Report returns a minimal report wit", "originalRequest": { "method": "POST", "header": [ @@ -22922,7 +24556,7 @@ }, "response": [ { - "name": "The report is being generated. When finished, a notification will be sent to the specified callback URL (Report Listener Service) and the report can be fetched using Get Report APIs. If you don't use a callback URL, Get Report returns a minimal report with the following status: 'inProgress'. Repeat the call every 20 seconds until Get Report returns a different status.", + "name": "The report is being generated. When finished, a notification will be sent to the specified callback URL (Report Listener Service) and the report can be fetched using Get Report APIs. If you don't use a callback URL, Get Report returns a minimal report wit", "originalRequest": { "method": "POST", "header": [ @@ -23260,7 +24894,7 @@ }, "response": [ { - "name": "The report is being generated. When finished, a notification will be sent to the specified callback URL (Report Listener Service) and the report can be fetched using Get Report APIs. If you don't use a callback URL, Get Report returns a minimal report with the following status: 'inProgress'. Repeat the call every 20 seconds until Get Report returns a different status.", + "name": "The report is being generated. When finished, a notification will be sent to the specified callback URL (Report Listener Service) and the report can be fetched using Get Report APIs. If you don't use a callback URL, Get Report returns a minimal report wit", "originalRequest": { "method": "POST", "header": [ @@ -23534,7 +25168,7 @@ }, "response": [ { - "name": "The report is being generated. When finished, a notification will be sent to the specified callback URL (Report Listener Service) and the report can be fetched using Get Report APIs. If you don't use a callback URL, Get Report returns a minimal report with the following status: 'inProgress'. Repeat the call every 20 seconds until Get Report returns a different status.", + "name": "The report is being generated. When finished, a notification will be sent to the specified callback URL (Report Listener Service) and the report can be fetched using Get Report APIs. If you don't use a callback URL, Get Report returns a minimal report wit", "originalRequest": { "method": "POST", "header": [ @@ -23808,7 +25442,7 @@ }, "response": [ { - "name": "The report is being generated. When finished, a notification will be sent to the specified callback URL (Report Listener Service) and the report can be fetched using Get Report APIs. If you don't use a callback URL, Get Report returns a minimal report with the following status: 'inProgress'. Repeat the call every 20 seconds until Get Report returns a different status.", + "name": "The report is being generated. When finished, a notification will be sent to the specified callback URL (Report Listener Service) and the report can be fetched using Get Report APIs. If you don't use a callback URL, Get Report returns a minimal report wit", "originalRequest": { "method": "POST", "header": [ @@ -24082,7 +25716,7 @@ }, "response": [ { - "name": "The report is being generated. When finished, a notification will be sent to the specified callback URL (Report Listener Service) and the report can be fetched using Get Report APIs. If you don't use a callback URL, Get Report returns a minimal report with the following status: 'inProgress'. Repeat the call every 20 seconds until Get Report returns a different status.", + "name": "The report is being generated. When finished, a notification will be sent to the specified callback URL (Report Listener Service) and the report can be fetched using Get Report APIs. If you don't use a callback URL, Get Report returns a minimal report wit", "originalRequest": { "method": "POST", "header": [ @@ -24357,7 +25991,7 @@ }, "response": [ { - "name": "The report is being generated. When finished, a notification will be sent to the specified callback URL (Report Listener Service) and the report can be fetched using Get Report APIs. If you don't use a callback URL, Get Report returns a minimal report with the following status: 'inProgress'. Repeat the call every 20 seconds until Get Report returns a different status.", + "name": "The report is being generated. When finished, a notification will be sent to the specified callback URL (Report Listener Service) and the report can be fetched using Get Report APIs. If you don't use a callback URL, Get Report returns a minimal report wit", "originalRequest": { "method": "POST", "header": [ @@ -24636,7 +26270,7 @@ }, "response": [ { - "name": "The report is being generated. When finished, a notification will be sent to the specified callback URL (Report Listener Service) and the report can be fetched using Get Report APIs. If you don't use a callback URL, Get Report returns a minimal report with the following status: 'inProgress'. Repeat the call every 20 seconds until Get Report returns a different status.", + "name": "The report is being generated. When finished, a notification will be sent to the specified callback URL (Report Listener Service) and the report can be fetched using Get Report APIs. If you don't use a callback URL, Get Report returns a minimal report wit", "originalRequest": { "method": "POST", "header": [ @@ -24914,7 +26548,7 @@ }, "response": [ { - "name": "The report is being generated. When finished, a notification will be sent to the specified callback URL (Report Listener Service) and the report can be fetched using Get Report APIs. If you don't use a callback URL, Get Report returns a minimal report with the following status: 'inProgress'. Repeat the call every 20 seconds until Get Report returns a different status.", + "name": "The report is being generated. When finished, a notification will be sent to the specified callback URL (Report Listener Service) and the report can be fetched using Get Report APIs. If you don't use a callback URL, Get Report returns a minimal report wit", "originalRequest": { "method": "POST", "header": [ @@ -25284,6 +26918,14 @@ { "value": "", "disabled": true + }, + { + "key": "avaCustomerId", + "value": "" + }, + { + "key": "avaAccountId", + "value": "" } ] } \ No newline at end of file