Skip to content

The Postman Collection for Mastercard Open Banking APIs (๐Ÿ‡บ๐Ÿ‡ธ) tested using Newman and the Test Drive sandbox.

License

Notifications You must be signed in to change notification settings

Mastercard/open-banking-us-postman

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

65 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

open-banking-us-postman

Overview

The Postman collection for Open Banking APIs (๐Ÿ‡บ๐Ÿ‡ธ) tested using 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:

Collection

JSON โค“

Run the Collection

Things to Know ๐Ÿ‘‡

project

  • Before running the collection, you need a Customer ID. For that, follow Welcome Your First Customer or run the setup script. This script will call:
    • addTestingCustomer
    • generateConnectUrl (Connect Application). Simply open the URL, search for "FinBank Profiles - A" and add to your test customer all accounts from profile_03.
    • refreshCustomerAccounts

Import or Fork the Collection

  1. Click:
  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'

Run the Collection in GitHub

  1. Fork this repository
  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: โœ”๏ธ

What's Next?

Guidelines

The Open Banking Postman Collection was created from the Open Banking API specification and must be maintained accordingly.