{"id":28577543,"url":"https://github.com/mastercard/open-banking-us-postman","last_synced_at":"2025-08-22T14:06:47.201Z","repository":{"id":43141235,"uuid":"483577554","full_name":"Mastercard/open-banking-us-postman","owner":"Mastercard","description":"The Postman Collection for Mastercard Open Banking APIs (🇺🇸) tested using Newman and the Test Drive sandbox.","archived":false,"fork":false,"pushed_at":"2024-10-09T15:44:34.000Z","size":484,"stargazers_count":18,"open_issues_count":1,"forks_count":27,"subscribers_count":10,"default_branch":"main","last_synced_at":"2025-06-11T00:48:51.988Z","etag":null,"topics":["api","finicity","mastercard","openbanking","postman","postman-collection"],"latest_commit_sha":null,"homepage":"https://mstr.cd/3ZtLuT8","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Mastercard.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2022-04-20T08:50:37.000Z","updated_at":"2025-04-24T16:02:22.000Z","dependencies_parsed_at":"2024-02-08T15:28:39.148Z","dependency_job_id":"c6040985-c8c2-44dd-8fe8-d73f81bca567","html_url":"https://github.com/Mastercard/open-banking-us-postman","commit_stats":null,"previous_names":["mastercard/open-banking-us-postman"],"tags_count":7,"template":false,"template_full_name":null,"purl":"pkg:github/Mastercard/open-banking-us-postman","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Mastercard%2Fopen-banking-us-postman","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Mastercard%2Fopen-banking-us-postman/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Mastercard%2Fopen-banking-us-postman/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Mastercard%2Fopen-banking-us-postman/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Mastercard","download_url":"https://codeload.github.com/Mastercard/open-banking-us-postman/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Mastercard%2Fopen-banking-us-postman/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":271650858,"owners_count":24796725,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-22T02:00:08.480Z","response_time":65,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","finicity","mastercard","openbanking","postman","postman-collection"],"created_at":"2025-06-11T00:38:12.474Z","updated_at":"2025-08-22T14:06:46.835Z","avatar_url":"https://github.com/Mastercard.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# open-banking-us-postman\r\n[![](https://raw.githubusercontent.com/Mastercard/open-banking-us-openapi/main/res/logo.png)](https://developer.mastercard.com/product/open-banking/#gh-light-mode-only)\r\n[![](https://raw.githubusercontent.com/Mastercard/open-banking-us-openapi/main/res/logo-dark.png)](https://developer.mastercard.com/product/open-banking/#gh-dark-mode-only)\r\n\r\n## Overview\r\n\r\nThe [Postman](https://www.postman.com/) collection for [Open Banking APIs](https://developer.mastercard.com/open-banking-us/documentation) (🇺🇸) tested using [Newman](https://learning.postman.com/docs/running-collections/using-newman-cli/command-line-integration-with-newman/) and the Test Drive plan.\r\n\r\n## Workflows\r\n\r\nThe following workflow runs the collection and ensures it can be used to consume and test the Open Banking APIs:\r\n\r\n[![](https://github.com/Mastercard/open-banking-us-postman/actions/workflows/newman.yml/badge.svg)](https://github.com/Mastercard/open-banking-us-postman/actions/workflows/newman.yml)\r\n\r\n## Collection\r\n[JSON ⤓](./openbanking-us.postman_collection.json)\r\n\r\n## Run the Collection\r\n### Things to Know :point_down:\r\n\r\n* A [free Mastercard Developers account](https://developer.mastercard.com/product/open-banking) is required to obtain your **Partner ID**, **Partner Secret** and **App Key**:\r\n\r\n![project]([https://user-images.githubusercontent.com/3964455/221236073-5661d083-0a04-4d46-9710-3c0c8c9e9a6a.gif](https://github.com/Mastercard/open-banking-us-postman/assets/147383171/7a1033ef-c2d2-4a8a-8295-dedf12816413)) \r\n\r\n* Before running the collection, you need a **Customer ID**. For that, follow [Welcome Your First Customer](https://mstr.cd/3Z5de0Q) or run the [setup script](https://github.com/Mastercard/open-banking-us-openapi/blob/main/bin/). This script will call:\r\n  * `addTestingCustomer`\r\n  * `generateConnectUrl` ([Connect Application](https://developer.mastercard.com/open-banking-us/documentation/connect/)). Simply open the URL, search for \"FinBank Profiles - A\" and add to your test customer all accounts from [`profile_03`](https://developer.mastercard.com/open-banking-us/documentation/test-the-apis/#bank-account-profiles).\r\n  * `refreshCustomerAccounts`\r\n\r\n\u003cp align=\"center\"\u003e\r\n\u003cimg src=\"https://user-images.githubusercontent.com/13854193/277695116-11235128-67d8-47a6-8b1b-c93e35e590da.gif\" width=\"300px\"/\u003e\r\n\u003c/p\u003e\r\n\r\n### Import or Fork the Collection\r\n\r\n1. Click: [![](https://run.pstmn.io/button.svg)](https://god.gw.postman.com/run-collection/26779181-9e1743cb-a29b-47cc-9869-3bcf577c5db5?action=collection%2Ffork\u0026source=rip_markdown\u0026collection-url=entityId%3D26779181-9e1743cb-a29b-47cc-9869-3bcf577c5db5%26entityType%3Dcollection%26workspaceId%3D0d6593a8-1921-4fe4-a73c-687c945c5c02#?env%5B%F0%9F%87%BA%F0%9F%87%B8%20Mastercard%20Open%20Banking%20Environment%20US%5D=W3sia2V5IjoicGFydG5lcklkIiwidmFsdWUiOiJ7Y2hhbmdlbWV9IiwiZW5hYmxlZCI6dHJ1ZSwidHlwZSI6ImRlZmF1bHQiLCJzZXNzaW9uVmFsdWUiOiJ7Y2hhbmdlbWV9Iiwic2Vzc2lvbkluZGV4IjowfSx7ImtleSI6InBhcnRuZXJTZWNyZXQiLCJ2YWx1ZSI6IntjaGFuZ2VtZX0iLCJlbmFibGVkIjp0cnVlLCJ0eXBlIjoiZGVmYXVsdCIsInNlc3Npb25WYWx1ZSI6IntjaGFuZ2VtZX0iLCJzZXNzaW9uSW5kZXgiOjF9LHsia2V5IjoiYXBwS2V5IiwidmFsdWUiOiJ7Y2hhbmdlbWV9IiwiZW5hYmxlZCI6dHJ1ZSwidHlwZSI6ImRlZmF1bHQiLCJzZXNzaW9uVmFsdWUiOiJ7Y2hhbmdlbWV9Iiwic2Vzc2lvbkluZGV4IjoyfSx7ImtleSI6ImN1c3RvbWVySWQiLCJ2YWx1ZSI6IntjaGFuZ2VtZX0iLCJlbmFibGVkIjp0cnVlLCJ0eXBlIjoidGV4dCIsInNlc3Npb25WYWx1ZSI6IntjaGFuZ2VtZX0iLCJzZXNzaW9uSW5kZXgiOjN9LHsia2V5Ijoibm93SXNvODYwMSIsInZhbHVlIjoiIiwiZW5hYmxlZCI6dHJ1ZSwidHlwZSI6ImFueSIsInNlc3Npb25WYWx1ZSI6IiIsInNlc3Npb25JbmRleCI6NH0seyJrZXkiOiJ0b21vcnJvd0lzbzg2MDEiLCJ2YWx1ZSI6IiIsImVuYWJsZWQiOnRydWUsInR5cGUiOiJhbnkiLCJzZXNzaW9uVmFsdWUiOiIiLCJzZXNzaW9uSW5kZXgiOjV9XQ==)\r\n2. Select the _Test Drive_ environment (top right) and update `partnerId`, `partnerSecret`, `appKey` and `customerId` variables\r\n3. Click _Send_ on individual requests, or _Run collection_\r\n4. Explore the _Pre-request Script_ and _Tests_ tabs, and update the collection as you wish\r\n\r\n### Run the Collection on the Command Line\r\n\r\n1. Clone this repository\r\n2. Run `npx newman run openbanking-us.postman_collection.json --env-var partnerId=*** --env-var partnerSecret=*** --env-var appKey=*** --env-var customerId=*** --folder 'All APIs'`\r\n\r\n![](https://user-images.githubusercontent.com/3964455/194878975-1b8f3051-68d5-478e-95cb-bd8b15d84379.gif)\r\n\r\n### Run the Collection in GitHub\r\n\r\n1. [Fork this repository](https://github.com/Mastercard/open-banking-us-postman/fork)\r\n2. Go to _Settings_ \u003e _Secrets_ \u003e _Actions_\r\n3. Create new repository secrets: `PARTNER_ID`, `PARTNER_SECRET` and `APP_KEY`\r\n4. Enable workflows in the _Actions_ tab\r\n5. Click _Run workflow_ under _Newman_. Expected result: :heavy_check_mark:\r\n\r\n## What's Next?\r\n\r\n* Postman allows you to generate [code snippets](https://learning.postman.com/docs/sending-requests/generate-code-snippets/) you can use into your application\r\n* You may also be interested in generating an API client from the [Open Banking API specification](https://github.com/Mastercard/open-banking-us-openapi)\r\n\r\n## Guidelines\r\n\r\nThe Open Banking Postman Collection was created from the [Open Banking API specification](https://github.com/Mastercard/open-banking-us-openapi) and must be maintained accordingly.\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmastercard%2Fopen-banking-us-postman","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmastercard%2Fopen-banking-us-postman","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmastercard%2Fopen-banking-us-postman/lists"}