diff --git a/openbanking-us.postman_collection.json b/openbanking-us.postman_collection.json index b1544d5..25b0c17 100644 --- a/openbanking-us.postman_collection.json +++ b/openbanking-us.postman_collection.json @@ -2,7 +2,7 @@ "info": { "_postman_id": "9e1743cb-a29b-47cc-9869-3bcf577c5db5", "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)", + "description": "Postman Collection for Mastercard Open Banking APIs\n\n\n\nContact Support: \nName: API Support \nEmail: [apisupport@mastercard.com](https://mailto:apisupport@mastercard.com)", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "_exporter_id": "30686484" }, @@ -8245,9 +8245,1721 @@ "body": "{\n \"code\": 10100,\n \"message\": \"Cannot find consumer with id 1234.\"\n}" } ] + }, + { + "name": "Get Customer Account Multiple Statements", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "type": "text" + }, + { + "key": "Finicity-App-Key", + "value": "{{appKey}}", + "type": "text" + }, + { + "key": "Finicity-App-Token", + "value": "{{appToken}}", + "type": "text" + } + ], + "url": { + "raw": "{{baseUrl}}/aggregation/v3/customers/{{customerId}}/accounts/{{accountId}}/statement?index=1,2,3,4,5,6", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "aggregation", + "v3", + "customers", + "{{customerId}}", + "accounts", + "{{accountId}}", + "statement" + ], + "query": [ + { + "key": "index", + "value": "1,2,3,4,5,6", + "description": "Request statements with comma-separated indexes ranged between 1-24. The default value is 1 and it will return the most recent statement. Increasing the index will return older statements, for example, setting the index value to 6 will return a statement from six months ago." + } + ] + }, + "description": "This endpoint is retrieving the account statement for a given customer. The maximum number of indexes it will fetch for a single login is 24.\n\n_Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png)" + }, + "response": [ + { + "name": "The account statements were successfully retrieved.", + "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}}/aggregation/v3/customers/:customerId/accounts/:accountId/statement?index=1,2,3,4,5,6", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "aggregation", + "v3", + "customers", + ":customerId", + "accounts", + ":accountId", + "statement" + ], + "query": [ + { + "key": "index", + "value": "1,2,3,4,5,6", + "description": "Request statements with comma-separated indexes ranged between 1-24. The default value is 1 and it will return the most recent statement. Increasing the index will return older statements, for example, setting the index value to 6 will return a statement from six months ago." + } + ], + "variable": [ + { + "key": "customerId" + }, + { + "key": "accountId" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"statements\": [\n {\n \"index\": \"1\",\n \"asOfDate\": 1669036741,\n \"description\": \"08/28/2020 - 09/27/2020\",\n \"documentDate\": \"2020-09-27\"\n },\n {\n \"index\": \"2\",\n \"asOfDate\": 1669036741,\n \"code\": \"960\",\n \"message\": \"statement not found.\"\n }\n ]\n}" + }, + { + "name": "The response contains an MFA challenge in XML or JSON format. Contact your Account Manager or Systems Engineers to determine the best route to handle this error.", + "originalRequest": { + "method": "GET", + "header": [ + { + "description": "Added as a part of security scheme: apikey", + "key": "Finicity-App-Key", + "value": "" + } + ], + "url": { + "raw": "{{baseUrl}}/aggregation/v3/customers/:customerId/accounts/:accountId/statement?index=1,2,3,4,5,6", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "aggregation", + "v3", + "customers", + ":customerId", + "accounts", + ":accountId", + "statement" + ], + "query": [ + { + "key": "index", + "value": "1,2,3,4,5,6", + "description": "Request statements with comma-separated indexes ranged between 1-24. The default value is 1 and it will return the most recent statement. Increasing the index will return older statements, for example, setting the index value to 6 will return a statement from six months ago." + } + ], + "variable": [ + { + "key": "customerId" + }, + { + "key": "accountId" + } + ] + } + }, + "status": "Non-Authoritative Information (since HTTP/1.1)", + "code": 203, + "_postman_previewlanguage": "text", + "header": [], + "cookie": [], + "body": "" + }, + { + "name": "MissingFieldExample", + "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}}/aggregation/v3/customers/:customerId/accounts/:accountId/statement?index=1,2,3,4,5,6", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "aggregation", + "v3", + "customers", + ":customerId", + "accounts", + ":accountId", + "statement" + ], + "query": [ + { + "key": "index", + "value": "1,2,3,4,5,6", + "description": "Request statements with comma-separated indexes ranged between 1-24. The default value is 1 and it will return the most recent statement. Increasing the index will return older statements, for example, setting the index value to 6 will return a statement from six months ago." + } + ], + "variable": [ + { + "key": "customerId" + }, + { + "key": "accountId" + } + ] + } + }, + "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": "InvalidFieldExample", + "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}}/aggregation/v3/customers/:customerId/accounts/:accountId/statement?index=1,2,3,4,5,6", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "aggregation", + "v3", + "customers", + ":customerId", + "accounts", + ":accountId", + "statement" + ], + "query": [ + { + "key": "index", + "value": "1,2,3,4,5,6", + "description": "Request statements with comma-separated indexes ranged between 1-24. The default value is 1 and it will return the most recent statement. Increasing the index will return older statements, for example, setting the index value to 6 will return a statement from six months ago." + } + ], + "variable": [ + { + "key": "customerId" + }, + { + "key": "accountId" + } + ] + } + }, + "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\": \"Customer ID does not exist or does not belong to this partner\",\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": "InvalidExperienceFieldExample", + "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}}/aggregation/v3/customers/:customerId/accounts/:accountId/statement?index=1,2,3,4,5,6", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "aggregation", + "v3", + "customers", + ":customerId", + "accounts", + ":accountId", + "statement" + ], + "query": [ + { + "key": "index", + "value": "1,2,3,4,5,6", + "description": "Request statements with comma-separated indexes ranged between 1-24. The default value is 1 and it will return the most recent statement. Increasing the index will return older statements, for example, setting the index value to 6 will return a statement from six months ago." + } + ], + "variable": [ + { + "key": "customerId" + }, + { + "key": "accountId" + } + ] + } + }, + "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\": \"\\\"experience\\\" must be a valid GUID\",\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": "GenericBadRequestExample", + "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}}/aggregation/v3/customers/:customerId/accounts/:accountId/statement?index=1,2,3,4,5,6", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "aggregation", + "v3", + "customers", + ":customerId", + "accounts", + ":accountId", + "statement" + ], + "query": [ + { + "key": "index", + "value": "1,2,3,4,5,6", + "description": "Request statements with comma-separated indexes ranged between 1-24. The default value is 1 and it will return the most recent statement. Increasing the index will return older statements, for example, setting the index value to 6 will return a statement from six months ago." + } + ], + "variable": [ + { + "key": "customerId" + }, + { + "key": "accountId" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": 14020,\n \"message\": \"Bad request.\"\n}" + }, + { + "name": "AccountTypeNotSupportedExample", + "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}}/aggregation/v3/customers/:customerId/accounts/:accountId/statement?index=1,2,3,4,5,6", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "aggregation", + "v3", + "customers", + ":customerId", + "accounts", + ":accountId", + "statement" + ], + "query": [ + { + "key": "index", + "value": "1,2,3,4,5,6", + "description": "Request statements with comma-separated indexes ranged between 1-24. The default value is 1 and it will return the most recent statement. Increasing the index will return older statements, for example, setting the index value to 6 will return a statement from six months ago." + } + ], + "variable": [ + { + "key": "customerId" + }, + { + "key": "accountId" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": 14020,\n \"message\": \"Bad request. (Account type not supported).\"\n}" + }, + { + "name": "ExpiredTokenExample", + "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}}/aggregation/v3/customers/:customerId/accounts/:accountId/statement?index=1,2,3,4,5,6", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "aggregation", + "v3", + "customers", + ":customerId", + "accounts", + ":accountId", + "statement" + ], + "query": [ + { + "key": "index", + "value": "1,2,3,4,5,6", + "description": "Request statements with comma-separated indexes ranged between 1-24. The default value is 1 and it will return the most recent statement. Increasing the index will return older statements, for example, setting the index value to 6 will return a statement from six months ago." + } + ], + "variable": [ + { + "key": "customerId" + }, + { + "key": "accountId" + } + ] + } + }, + "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": "MissingFinicityAppKeyExample", + "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}}/aggregation/v3/customers/:customerId/accounts/:accountId/statement?index=1,2,3,4,5,6", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "aggregation", + "v3", + "customers", + ":customerId", + "accounts", + ":accountId", + "statement" + ], + "query": [ + { + "key": "index", + "value": "1,2,3,4,5,6", + "description": "Request statements with comma-separated indexes ranged between 1-24. The default value is 1 and it will return the most recent statement. Increasing the index will return older statements, for example, setting the index value to 6 will return a statement from six months ago." + } + ], + "variable": [ + { + "key": "customerId" + }, + { + "key": "accountId" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": 10026,\n \"message\": \"Missing parameter (Finicity-App-Key)\"\n}" + }, + { + "name": "ConsumerNotFoundExample", + "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}}/aggregation/v3/customers/:customerId/accounts/:accountId/statement?index=1,2,3,4,5,6", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "aggregation", + "v3", + "customers", + ":customerId", + "accounts", + ":accountId", + "statement" + ], + "query": [ + { + "key": "index", + "value": "1,2,3,4,5,6", + "description": "Request statements with comma-separated indexes ranged between 1-24. The default value is 1 and it will return the most recent statement. Increasing the index will return older statements, for example, setting the index value to 6 will return a statement from six months ago." + } + ], + "variable": [ + { + "key": "customerId" + }, + { + "key": "accountId" + } + ] + } + }, + "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": "NoAccountForInstitutionLoginIdExample", + "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}}/aggregation/v3/customers/:customerId/accounts/:accountId/statement?index=1,2,3,4,5,6", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "aggregation", + "v3", + "customers", + ":customerId", + "accounts", + ":accountId", + "statement" + ], + "query": [ + { + "key": "index", + "value": "1,2,3,4,5,6", + "description": "Request statements with comma-separated indexes ranged between 1-24. The default value is 1 and it will return the most recent statement. Increasing the index will return older statements, for example, setting the index value to 6 will return a statement from six months ago." + } + ], + "variable": [ + { + "key": "customerId" + }, + { + "key": "accountId" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"38007\",\n \"status\": \"404\",\n \"title\": \"Connecting accounts error\",\n \"user_message\": \"Customer does not have any accounts associated with institutionLoginId.\",\n \"tags\": \"\",\n \"level\": \"error\",\n \"message\": \"Customer does not have any accounts associated with institutionLoginId.\"\n}" + }, + { + "name": "CustomerNotFoundExample", + "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}}/aggregation/v3/customers/:customerId/accounts/:accountId/statement?index=1,2,3,4,5,6", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "aggregation", + "v3", + "customers", + ":customerId", + "accounts", + ":accountId", + "statement" + ], + "query": [ + { + "key": "index", + "value": "1,2,3,4,5,6", + "description": "Request statements with comma-separated indexes ranged between 1-24. The default value is 1 and it will return the most recent statement. Increasing the index will return older statements, for example, setting the index value to 6 will return a statement from six months ago." + } + ], + "variable": [ + { + "key": "customerId" + }, + { + "key": "accountId" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": 14001,\n \"message\": \"Customer not found.\"\n}" + }, + { + "name": "NoConsumerForCustomerExample", + "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}}/aggregation/v3/customers/:customerId/accounts/:accountId/statement?index=1,2,3,4,5,6", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "aggregation", + "v3", + "customers", + ":customerId", + "accounts", + ":accountId", + "statement" + ], + "query": [ + { + "key": "index", + "value": "1,2,3,4,5,6", + "description": "Request statements with comma-separated indexes ranged between 1-24. The default value is 1 and it will return the most recent statement. Increasing the index will return older statements, for example, setting the index value to 6 will return a statement from six months ago." + } + ], + "variable": [ + { + "key": "customerId" + }, + { + "key": "accountId" + } + ] + } + }, + "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 for customer with id 5011115315.\\\"\"\n}" + }, + { + "name": "ResourceNotFoundExample", + "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}}/aggregation/v3/customers/:customerId/accounts/:accountId/statement?index=1,2,3,4,5,6", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "aggregation", + "v3", + "customers", + ":customerId", + "accounts", + ":accountId", + "statement" + ], + "query": [ + { + "key": "index", + "value": "1,2,3,4,5,6", + "description": "Request statements with comma-separated indexes ranged between 1-24. The default value is 1 and it will return the most recent statement. Increasing the index will return older statements, for example, setting the index value to 6 will return a statement from six months ago." + } + ], + "variable": [ + { + "key": "customerId" + }, + { + "key": "accountId" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": 14001,\n \"message\": \"Resource not found.\"\n}" + }, + { + "name": "NoRegisteredApplicationExample", + "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}}/aggregation/v3/customers/:customerId/accounts/:accountId/statement?index=1,2,3,4,5,6", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "aggregation", + "v3", + "customers", + ":customerId", + "accounts", + ":accountId", + "statement" + ], + "query": [ + { + "key": "index", + "value": "1,2,3,4,5,6", + "description": "Request statements with comma-separated indexes ranged between 1-24. The default value is 1 and it will return the most recent statement. Increasing the index will return older statements, for example, setting the index value to 6 will return a statement from six months ago." + } + ], + "variable": [ + { + "key": "customerId" + }, + { + "key": "accountId" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": 50051,\n \"message\": \"No registered partner applications found.\"\n}" + }, + { + "name": "InstitutionLoginIdNotFoundErrorResponseExample", + "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}}/aggregation/v3/customers/:customerId/accounts/:accountId/statement?index=1,2,3,4,5,6", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "aggregation", + "v3", + "customers", + ":customerId", + "accounts", + ":accountId", + "statement" + ], + "query": [ + { + "key": "index", + "value": "1,2,3,4,5,6", + "description": "Request statements with comma-separated indexes ranged between 1-24. The default value is 1 and it will return the most recent statement. Increasing the index will return older statements, for example, setting the index value to 6 will return a statement from six months ago." + } + ], + "variable": [ + { + "key": "customerId" + }, + { + "key": "accountId" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"status\": \"404\",\n \"code\": 1606,\n \"message\": \"Resource Not Found.\",\n \"user_message\": \"Institution login id : 7008461438 is not found\"\n}" + } + ] + } + ], + "description": "Fetch account statements and generate reports asynchronously", + "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 accountId = pm.variables.get(\"accountId\")", + "if (accountId) {", + " return", + "}", + "", + "console.log(\"Fetching account ID ...\")", + "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)", + " pm.variables.set(\"accountId\", response.json().accounts[0].id)", + "})" + ] + } + } + ] + }, + { + "name": "Businesses API", + "item": [ + { + "name": "Create a New Business for a Customer", + "event": [ + { + "listen": "test", + "script": { + "exec": [ + "pm.test(\"Check status code\", function () {", + " pm.expect(pm.response.code).to.equal(200)", + " const businessId = pm.response.json().businessId", + " pm.environment.set(\"businessId\", businessId)", + "})" + ], + "type": "text/javascript" + } + }, + { + "listen": "prerequest", + "script": { + "exec": [ + "" + ], + "type": "text/javascript" + } + } + ], + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "type": "text" + }, + { + "key": "Accept", + "value": "application/json", + "type": "text" + }, + { + "key": "Finicity-App-Key", + "value": "{{appKey}}", + "type": "text" + }, + { + "key": "Finicity-App-Token", + "value": "{{appToken}}", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"ABC Tires Inc\",\n \"personallyLiable\": true,\n \"address\": {\n \"addressLine1\": \"434 W Ascension Way\",\n \"addressLine2\": \"Suite #200\",\n \"city\": \"Murray\",\n \"state\": \"UT\",\n \"country\": \"US\",\n \"postalCode\": \"84123\"\n },\n \"phoneNumber\": {\n \"countryCode\": \"1\",\n \"phoneNo\": \"8042221111\"\n },\n \"url\": \"https://www.finicity.com/\",\n \"email\": \"myname@mycompany.com\",\n \"type\": \"Nonprofit\",\n \"taxId\": \"A1234561Z\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/business-services/customers/{{customerId}}/businesses", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "business-services", + "customers", + "{{customerId}}", + "businesses" + ] + }, + "description": "Create a new business record for the associated customer.\nA customer can have one business record associated.\n\n_Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png)" + }, + "response": [ + { + "name": "The business was successfully created.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": "Added as a part of security scheme: apikey", + "key": "Finicity-App-Key", + "value": "" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"ABC Tires Inc\",\n \"personallyLiable\": true,\n \"address\": {\n \"addressLine1\": \"434 W Ascension Way\",\n \"addressLine2\": \"Suite #200\",\n \"city\": \"Murray\",\n \"state\": \"UT\",\n \"country\": \"US\",\n \"postalCode\": \"84123\"\n },\n \"phoneNumber\": {\n \"countryCode\": \"141\",\n \"phoneNo\": \"7992222\"\n },\n \"url\": \"https://www.finicity.com/\",\n \"email\": \"myname@mycompany.com\",\n \"type\": \"Nonprofit\",\n \"taxId\": \"A1234561Z\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/business-services/customers/{{customerId}}/businesses", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "business-services", + "customers", + "{{customerId}}", + "businesses" + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"name\": \"ABC Tires Inc\",\n \"personallyLiable\": true,\n \"address\": {\n \"addressLine1\": \"434 W Ascension Way\",\n \"addressLine2\": \"Suite #200\",\n \"city\": \"Murray\",\n \"state\": \"UT\",\n \"country\": \"US\",\n \"postalCode\": \"84123\"\n },\n \"phoneNumber\": {\n \"countryCode\": \"141\",\n \"phoneNo\": \"7992222\"\n },\n \"url\": \"https://www.finicity.com/\",\n \"email\": \"myname@mycompany.com\",\n \"type\": \"Nonprofit\",\n \"taxId\": \"A1234561Z\",\n \"businessId\": \"1112\",\n \"createdDate\": \"2022-04-12T11:51:23\",\n \"modifiedDate\": \"2022-04-12T11:51:23\"\n}" + }, + { + "name": "The customer does not exist", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": "Added as a part of security scheme: apikey", + "key": "Finicity-App-Key", + "value": "" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"ABC Tires Inc\",\n \"personallyLiable\": true,\n \"address\": {\n \"addressLine1\": \"434 W Ascension Way\",\n \"addressLine2\": \"Suite #200\",\n \"city\": \"Murray\",\n \"state\": \"UT\",\n \"country\": \"US\",\n \"postalCode\": \"84123\"\n },\n \"phoneNumber\": {\n \"countryCode\": \"141\",\n \"phoneNo\": \"7992222\"\n },\n \"url\": \"https://www.finicity.com/\",\n \"email\": \"myname@mycompany.com\",\n \"type\": \"Nonprofit\",\n \"taxId\": \"A1234561Z\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/business-services/customers/{{customerId}}/businesses", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "business-services", + "customers", + "{{customerId}}", + "businesses" + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": 10002,\n \"status\": \"404\",\n \"title\": \"Customer ID was not found.\",\n \"level\": null,\n \"message\": \"Customer ID was not found.\",\n \"user_message\": \"Customer ID was not found.\",\n \"assetId\": null,\n \"accountId\": null\n}" + }, + { + "name": "The resource already exists", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": "Added as a part of security scheme: apikey", + "key": "Finicity-App-Key", + "value": "" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"ABC Tires Inc\",\n \"personallyLiable\": true,\n \"address\": {\n \"addressLine1\": \"434 W Ascension Way\",\n \"addressLine2\": \"Suite #200\",\n \"city\": \"Murray\",\n \"state\": \"UT\",\n \"country\": \"US\",\n \"postalCode\": \"84123\"\n },\n \"phoneNumber\": {\n \"countryCode\": \"141\",\n \"phoneNo\": \"7992222\"\n },\n \"url\": \"https://www.finicity.com/\",\n \"email\": \"myname@mycompany.com\",\n \"type\": \"Nonprofit\",\n \"taxId\": \"A1234561Z\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/business-services/customers/{{customerId}}/businesses", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "business-services", + "customers", + "{{customerId}}", + "businesses" + ] + } + }, + "status": "Conflict", + "code": 409, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": 10004,\n \"status\": \"409\",\n \"title\": \"Business already exists for the given customer ID.\",\n \"level\": null,\n \"message\": \"Business already exists for the given customer ID.\",\n \"user_message\": \"Business already exists for the given customer ID.\",\n \"assetId\": null,\n \"accountId\": null\n}" + } + ] + }, + { + "name": "Get Business by ID", + "event": [ + { + "listen": "test", + "script": { + "exec": [ + "pm.test(\"Check status code\", function () {", + " pm.expect(pm.response.code).to.equal(200)", + "})" + ], + "type": "text/javascript" + } + }, + { + "listen": "prerequest", + "script": { + "exec": [ + "const businessId = pm.environment.get(\"businessId\")" + ], + "type": "text/javascript" + } + } + ], + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "type": "text" + }, + { + "key": "Finicity-App-Key", + "value": "{{appKey}}", + "type": "text" + }, + { + "key": "Finicity-App-Token", + "value": "{{appToken}}", + "type": "text" + } + ], + "url": { + "raw": "{{baseUrl}}/business-services/businesses/{{businessId}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "business-services", + "businesses", + "{{businessId}}" + ] + }, + "description": "Retrieve business details.\n\n_Supported regions_: ![\\U0001F1FA\\U0001F1F8](https://flagcdn.com/20x15/us.png)" + }, + "response": [ + { + "name": "The business information was successfully retrieved.", + "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}}/business-services/businesses/:business_id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "business-services", + "businesses", + ":business_id" + ], + "variable": [ + { + "key": "business_id" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "[\n {\n \"name\": \"ABC Tires Inc\",\n \"personallyLiable\": true,\n \"address\": {\n \"addressLine1\": \"434 W Ascension Way\",\n \"addressLine2\": \"Suite #200\",\n \"city\": \"Murray\",\n \"state\": \"UT\",\n \"country\": \"US\",\n \"postalCode\": \"84123\"\n },\n \"phoneNumber\": {\n \"countryCode\": \"141\",\n \"phoneNo\": \"7992222\"\n },\n \"url\": \"https://www.finicity.com/\",\n \"email\": \"myname@mycompany.com\",\n \"type\": \"Nonprofit\",\n \"taxId\": \"A1234561Z\",\n \"businessId\": \"1112\",\n \"createdDate\": \"2022-04-12T11:51:23\",\n \"modifiedDate\": \"2022-04-12T11:51:23\"\n }\n]" + }, + { + "name": "The business does not 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}}/business-services/businesses/:business_id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "business-services", + "businesses", + ":business_id" + ], + "variable": [ + { + "key": "business_id" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": 10003,\n \"message\": \"Business ID was not found.\",\n \"status\": \"404\",\n \"title\": \"Business ID was not found.\",\n \"user_message\": \"Business ID was not found.\"\n}" + } + ] + }, + { + "name": "Get Business for Customer", + "event": [ + { + "listen": "test", + "script": { + "exec": [ + "pm.test(\"Check status code\", function () {", + " pm.expect(pm.response.code).to.equal(200)", + "})" + ], + "type": "text/javascript" + } + }, + { + "listen": "prerequest", + "script": { + "exec": [ + "" + ], + "type": "text/javascript" + } + } + ], + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "type": "text" + }, + { + "key": "Finicity-App-Key", + "value": "{{appKey}}", + "type": "text" + }, + { + "key": "Finicity-App-Token", + "value": "{{appToken}}", + "type": "text" + } + ], + "url": { + "raw": "{{baseUrl}}/business-services/customers/{{customerId}}/businesses", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "business-services", + "customers", + "{{customerId}}", + "businesses" + ] + }, + "description": "Retrieve business details associated with a specific customer. By providing the unique customer identifier, details about the associated business can be accessed.\n\n_Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png)" + }, + "response": [ + { + "name": "The business information was successfully retrieved.", + "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}}/business-services/customers/:customer_id/businesses", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "business-services", + "customers", + ":customer_id", + "businesses" + ], + "variable": [ + { + "key": "customer_id" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "[\n {\n \"name\": \"ABC Tires Inc\",\n \"personallyLiable\": true,\n \"address\": {\n \"addressLine1\": \"434 W Ascension Way\",\n \"addressLine2\": \"Suite #200\",\n \"city\": \"Murray\",\n \"state\": \"UT\",\n \"country\": \"US\",\n \"postalCode\": \"84123\"\n },\n \"phoneNumber\": {\n \"countryCode\": \"141\",\n \"phoneNo\": \"7992222\"\n },\n \"url\": \"https://www.finicity.com/\",\n \"email\": \"myname@mycompany.com\",\n \"type\": \"Nonprofit\",\n \"taxId\": \"A1234561Z\",\n \"businessId\": \"1112\",\n \"createdDate\": \"2022-04-12T11:51:23\",\n \"modifiedDate\": \"2022-04-12T11:51:23\"\n }\n]" + }, + { + "name": "The customer does not 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}}/business-services/customers/:customer_id/businesses", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "business-services", + "customers", + ":customer_id", + "businesses" + ], + "variable": [ + { + "key": "customer_id" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": 10002,\n \"message\": \"Customer ID was not found.\",\n \"status\": \"404\",\n \"title\": \"Customer ID was not found.\",\n \"user_message\": \"Customer ID was not found.\"\n}" + } + ] + }, + { + "name": "Update Business by ID", + "event": [ + { + "listen": "prerequest", + "script": { + "exec": [ + "const businessId = pm.environment.get(\"businessId\")" + ], + "type": "text/javascript" + } + } + ], + "request": { + "method": "PUT", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "type": "text" + }, + { + "key": "Accept", + "value": "application/json", + "type": "text" + }, + { + "key": "Finicity-App-Key", + "value": "{{appKey}}", + "type": "text" + }, + { + "key": "Finicity-App-Token", + "value": "{{appToken}}", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"ABC Tires Inc\",\n \"personallyLiable\": true,\n \"address\": {\n \"addressLine1\": \"434 W Ascension Way\",\n \"addressLine2\": \"Suite #200\",\n \"city\": \"Murray\",\n \"state\": \"UT\",\n \"country\": \"US\",\n \"postalCode\": \"84123\"\n },\n \"phoneNumber\": {\n \"countryCode\": \"1\",\n \"phoneNo\": \"8042221111\"\n },\n \"url\": \"https://www.finicity.com/\",\n \"email\": \"myname@mycompany.com\",\n \"type\": \"Nonprofit\",\n \"taxId\": \"A1234561Z\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/business-services/businesses/{{businessId}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "business-services", + "businesses", + "{{businessId}}" + ] + }, + "description": "Update the details of a business based on its unique identifier. By providing the specific business ID and the updated information in the request, modifications can be made to the business's profile.\n\n_Supported regions_: ![🇺🇸](https://flagcdn.com/20x15/us.png)" + }, + "response": [ + { + "name": "The business information was updated.", + "originalRequest": { + "method": "PUT", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": "Added as a part of security scheme: apikey", + "key": "Finicity-App-Key", + "value": "" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"ABC Tires Inc\",\n \"personallyLiable\": true,\n \"address\": {\n \"addressLine1\": \"434 W Ascension Way\",\n \"addressLine2\": \"Suite #200\",\n \"city\": \"Murray\",\n \"state\": \"UT\",\n \"country\": \"US\",\n \"postalCode\": \"84123\"\n },\n \"phoneNumber\": {\n \"countryCode\": \"141\",\n \"phoneNo\": \"7992222\"\n },\n \"url\": \"https://www.finicity.com/\",\n \"email\": \"myname@mycompany.com\",\n \"type\": \"Nonprofit\",\n \"taxId\": \"A1234561Z\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/business-services/businesses/{{businessId}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "business-services", + "businesses", + "{{businessId}}" + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"businessId\": \"193\",\n \"name\": \"ABC Tires Inc\",\n \"personallyLiable\": true,\n \"address\": {\n \"addressLine1\": \"434 W Ascension Way\",\n \"addressLine2\": \"Suite #200\",\n \"city\": \"Murray\",\n \"state\": \"UT\",\n \"country\": \"US\",\n \"postalCode\": \"84123\"\n },\n \"phoneNumber\": {\n \"countryCode\": \"1\",\n \"phoneNo\": \"8042221111\"\n },\n \"taxId\": \"A1234561Z\",\n \"url\": \"https://www.finicity.com/\",\n \"email\": \"myname@mycompany.com\",\n \"type\": \"Nonprofit\",\n \"createdDate\": \"2024-02-01T17:13:39Z\",\n \"modifiedDate\": \"2024-02-01T17:20:35Z\"\n}" + }, + { + "name": "The business does not exist", + "originalRequest": { + "method": "PUT", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": "Added as a part of security scheme: apikey", + "key": "Finicity-App-Key", + "value": "" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"ABC Tires Inc\",\n \"personallyLiable\": true,\n \"address\": {\n \"addressLine1\": \"434 W Ascension Way\",\n \"addressLine2\": \"Suite #200\",\n \"city\": \"Murray\",\n \"state\": \"UT\",\n \"country\": \"US\",\n \"postalCode\": \"84123\"\n },\n \"phoneNumber\": {\n \"countryCode\": \"141\",\n \"phoneNo\": \"7992222\"\n },\n \"url\": \"https://www.finicity.com/\",\n \"email\": \"myname@mycompany.com\",\n \"type\": \"Nonprofit\",\n \"taxId\": \"A1234561Z\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/business-services/businesses/{{businessId}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "business-services", + "businesses", + "{{businessId}}" + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": 10003,\n \"status\": \"404\",\n \"title\": \"Business ID was not found.\",\n \"level\": null,\n \"message\": \"Business ID was not found.\",\n \"user_message\": \"Business ID was not found.\",\n \"assetId\": null,\n \"accountId\": null\n}" + } + ] } ], - "description": "Fetch account statements and generate reports asynchronously", "event": [ { "listen": "prerequest", @@ -8259,26 +9971,16 @@ "const customerId = pm.environment.get(\"customerId\")", "const appToken = pm.globals.get(\"appToken\")", "", - "const accountId = pm.variables.get(\"accountId\")", - "if (accountId) {", - " return", - "}", - "", - "console.log(\"Fetching account ID ...\")", - "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)", - " pm.variables.set(\"accountId\", response.json().accounts[0].id)", - "})" + "" + ] + } + }, + { + "listen": "test", + "script": { + "type": "text/javascript", + "exec": [ + "" ] } } @@ -26928,4 +28630,4 @@ "value": "" } ] -} \ No newline at end of file +}