README.md

finicity-postman

Overview

The Postman collection for Finicity APIs (🇺🇸) tested using Newman and the Finicity Test Drive.

Workflows

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

Collection

JSON ⤓

Run the Collection

Things to Know 👇

• A free Finicity account is required to obtain your Partner ID, Partner Secret and Finicity App Key:

• Before running the collection, you need a Customer ID. For that, run setup.sh and use the output of the script in the next sections. This script will call:
  • addTestingCustomer
  • generateConnectUrl (Finicity Connect). 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 finicity.postman_collection.json --env-var partnerId=*** --env-var partnerSecret=*** --env-var appKey=*** --env-var customerId=***

Run the Collection in GitHub

1. Fork this repository
2. Go to Settings > Secrets > Actions
3. Create new repository secrets: PARTNER_ID, PARTNER_SECRET, APP_KEY and CUSTOMER_ID
4. Enable workflows in the Actions tab
5. Click Run workflow under Newman. Expected result: ✔️

What's Next?

• Postman allows you to generate code snippets you can use into your application
• You may also be interested in generating an API client from the Finicity API specification

Guidelines

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