https://github.com/mastercard/open-banking-us-postman

The Postman Collection for Mastercard Open Banking APIs (🇺🇸) tested using Newman and the Test Drive sandbox.
https://github.com/mastercard/open-banking-us-postman

api finicity mastercard openbanking postman postman-collection

Last synced: 7 months ago
JSON representation

The Postman Collection for Mastercard Open Banking APIs (🇺🇸) tested using Newman and the Test Drive sandbox.

• Host: GitHub
• URL: https://github.com/mastercard/open-banking-us-postman
• Owner: Mastercard
• License: apache-2.0
• Created: 2022-04-20T08:50:37.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2024-10-09T15:44:34.000Z (over 1 year ago)
• Last Synced: 2025-06-11T00:48:51.988Z (9 months ago)
• Topics: api, finicity, mastercard, openbanking, postman, postman-collection
• Homepage: https://mstr.cd/3ZtLuT8
• Size: 473 KB
• Stars: 18
• Watchers: 10
• Forks: 27
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# open-banking-us-postman

[![](https://raw.githubusercontent.com/Mastercard/open-banking-us-openapi/main/res/logo.png)](https://developer.mastercard.com/product/open-banking/#gh-light-mode-only)

[![](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)

## Overview

The [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.

## Workflows

The following workflow runs the collection and ensures it can be used to consume and test the Open Banking APIs:

[![](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)

## Collection

[JSON ⤓](./openbanking-us.postman_collection.json)

## Run the Collection

### Things to Know :point_down:

* A [free Mastercard Developers account](https://developer.mastercard.com/product/open-banking) is required to obtain your **Partner ID**, **Partner Secret** and **App Key**:

![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)) 

* 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:

  * `addTestingCustomer`

  * `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).

  * `refreshCustomerAccounts`







### Import or Fork the Collection

1. Click: [![](https://run.pstmn.io/button.svg)](https://god.gw.postman.com/run-collection/26779181-9e1743cb-a29b-47cc-9869-3bcf577c5db5?action=collection%2Ffork&source=rip_markdown&collection-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==)

2. Select the _Test Drive_ environment (top right) and update `partnerId`, `partnerSecret`, `appKey` and `customerId` variables

3. Click _Send_ on individual requests, or _Run collection_

4. Explore the _Pre-request Script_ and _Tests_ tabs, and update the collection as you wish

### Run the Collection on the Command Line

1. Clone this repository

2. Run `npx newman run openbanking-us.postman_collection.json --env-var partnerId=*** --env-var partnerSecret=*** --env-var appKey=*** --env-var customerId=*** --folder 'All APIs'`

![](https://user-images.githubusercontent.com/3964455/194878975-1b8f3051-68d5-478e-95cb-bd8b15d84379.gif)

### Run the Collection in GitHub

1. [Fork this repository](https://github.com/Mastercard/open-banking-us-postman/fork)

2. Go to _Settings_ > _Secrets_ > _Actions_

3. Create new repository secrets: `PARTNER_ID`, `PARTNER_SECRET` and `APP_KEY`

4. Enable workflows in the _Actions_ tab

5. Click _Run workflow_ under _Newman_. Expected result: :heavy_check_mark:

## What's Next?

* Postman allows you to generate [code snippets](https://learning.postman.com/docs/sending-requests/generate-code-snippets/) you can use into your application

* You may also be interested in generating an API client from the [Open Banking API specification](https://github.com/Mastercard/open-banking-us-openapi)

## Guidelines

The 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.