{"id":28577471,"url":"https://github.com/mastercard/open-banking-us-openapi","last_synced_at":"2026-02-27T11:16:01.046Z","repository":{"id":39919948,"uuid":"445106140","full_name":"Mastercard/open-banking-us-openapi","owner":"Mastercard","description":"The OpenAPI specification for Mastercard Open Banking APIs (🇺🇸), along with a suite of tests using a generated API client and the Test Drive sandbox.","archived":false,"fork":false,"pushed_at":"2026-02-11T18:02:55.000Z","size":4357,"stargazers_count":52,"open_issues_count":7,"forks_count":73,"subscribers_count":10,"default_branch":"main","last_synced_at":"2026-02-12T01:47:50.872Z","etag":null,"topics":["api","finicity","mastercard","openapi","openapi-generator","openbanking"],"latest_commit_sha":null,"homepage":"https://mstr.cd/3ZtLuT8","language":"Java","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,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2022-01-06T09:04:57.000Z","updated_at":"2026-02-11T17:31:26.000Z","dependencies_parsed_at":"2026-01-16T15:06:45.627Z","dependency_job_id":null,"html_url":"https://github.com/Mastercard/open-banking-us-openapi","commit_stats":null,"previous_names":["mastercard/open-banking-us-openapi"],"tags_count":95,"template":false,"template_full_name":null,"purl":"pkg:github/Mastercard/open-banking-us-openapi","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Mastercard%2Fopen-banking-us-openapi","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Mastercard%2Fopen-banking-us-openapi/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Mastercard%2Fopen-banking-us-openapi/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Mastercard%2Fopen-banking-us-openapi/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Mastercard","download_url":"https://codeload.github.com/Mastercard/open-banking-us-openapi/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Mastercard%2Fopen-banking-us-openapi/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29892074,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-27T09:48:51.284Z","status":"ssl_error","status_checked_at":"2026-02-27T09:48:43.992Z","response_time":57,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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","openapi","openapi-generator","openbanking"],"created_at":"2025-06-11T00:37:50.954Z","updated_at":"2026-02-27T11:16:01.019Z","avatar_url":"https://github.com/Mastercard.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# open-banking-us-openapi\n[![](./res/logo.png)](https://developer.mastercard.com/product/open-banking/#gh-light-mode-only)\n[![](./res/logo-dark.png)](https://developer.mastercard.com/product/open-banking/#gh-dark-mode-only)\n\n## Overview\n\nThe OpenAPI specification for [Open Banking APIs](https://developer.mastercard.com/open-banking-us/documentation) (🇺🇸), along with a suite of [tests](./tests/src/test/java/com/mastercard/openbanking/client/api) using a generated API client and the Test Drive plan.\n\n## Workflows\n\nThe following workflows ensure the API specification stays in good shape and can be used to consume the Open Banking APIs from your application:\n\n[![](https://github.com/Mastercard/open-banking-us-openapi/actions/workflows/prettier.yml/badge.svg)](https://github.com/Mastercard/open-banking-us-openapi/actions/workflows/prettier.yml)\n[![](https://github.com/Mastercard/open-banking-us-openapi/actions/workflows/swagger-editor.yml/badge.svg)](https://github.com/Mastercard/open-banking-us-openapi/actions/workflows/swagger-editor.yml)\n[![](https://github.com/Mastercard/open-banking-us-openapi/actions/workflows/redoc.yml/badge.svg)](https://github.com/Mastercard/open-banking-us-openapi/actions/workflows/redoc.yml)\n[![](https://github.com/Mastercard/open-banking-us-openapi/actions/workflows/openapi-generator.yml/badge.svg)](https://github.com/Mastercard/open-banking-us-openapi/actions/workflows/openapi-generator.yml)\n[![](https://github.com/Mastercard/open-banking-us-openapi/actions/workflows/tests.yml/badge.svg)](https://github.com/Mastercard/open-banking-us-openapi/actions/workflows/tests.yml)\n\n## Specification\n[YAML ⤓](./openbanking-us.yaml) | [Swagger Editor ⬈](https://editor.swagger.io/?url=https%3A%2F%2Fraw.githubusercontent.com%2FMastercard%2Fopen-banking-us-openapi%2Fmain%2Fopenbanking-us.yaml) | [Redoc ⬈](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/Mastercard/open-banking-us-openapi/main/openbanking-us.yaml\u0026nocors)\n\n## Tests\n### Things to Know :point_down:\n\n* The [test project](./tests) generates an API client library from the API specification like you would do in a real application (OpenAPI Generator is used for that)\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**:\n\n![project](https://github.com/Mastercard/open-banking-us-openapi/assets/147383171/46c787a3-142f-4843-8944-916a8d9e884e)\n\n* Before running the tests, you need a **Customer ID**. For that, follow [Welcome Your First Customer](https://mstr.cd/3Z5de0Q) or run the [setup script](./bin/). This script will call:\n  * `addTestingCustomer`\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).\n  * `refreshCustomerAccounts`\n\n\u003cp align=\"center\"\u003e\n\u003cimg src=\"https://github.com/Mastercard/open-banking-us-openapi/assets/13854193/11235128-67d8-47a6-8b1b-c93e35e590da.gif\" width=\"300px\"/\u003e\n\u003c/p\u003e\n\n\n### Run Tests Locally\n\n1. Clone this repository\n2. Run `cd tests \u0026\u0026 mvn clean test -DpartnerId=*** -DpartnerSecret=*** -DappKey=*** -DcustomerId=***`\n\n![](https://user-images.githubusercontent.com/3964455/194875163-af06b1a2-f2a2-44fe-a62e-73eb8fa78b35.gif)\n\n### Run Tests in GitHub\n\n1. [Fork this repository](https://github.com/Mastercard/open-banking-us-openapi/fork)\n2. Go to _Settings_ \u003e _Secrets_ \u003e _Actions_\n3. Create new repository secrets: `PARTNER_ID`, `PARTNER_SECRET` and `APP_KEY`\n4. Enable workflows in the _Actions_ tab\n5. Click _Run workflow_ under _API Client Tests_. Expected result: :heavy_check_mark:\n\n## What's Next?\n\nThe [Open Banking API specification](./openbanking-us.yaml) and a [generated API client](./tests) are the only things you need to call Open Banking APIs from your application. \n\n* For other software development frameworks and languages, see: OpenAPI Generator \u003e [Generators List](https://openapi-generator.tech/docs/generators).\n* You may also be interested in trying our [Postman collection](https://github.com/Mastercard/open-banking-us-postman).\n\n## Guidelines\n\nWhen updating the Open Banking API specification:\n1. Ensure it can be rendered without errors in [Swagger Editor](https://editor.swagger.io/?url=https%3A%2F%2Fraw.githubusercontent.com%2FMastercard%2Fopen-banking-us-openapi%2Fmain%2Fopenbanking-us.yaml) or [Redoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/Mastercard/open-banking-us-openapi/main/openbanking-us.yaml\u0026nocors)\n2. Ensure an API client can be generated using [OpenAPI Generator](https://openapi-generator.tech/)\n3. Prettify the YAML using `npx prettier --write --single-quote --prose-wrap always openbanking-us.yaml`\n4. Update and/or add tests to the [test project](./tests)\n   * Generate new tests by using `true` for `generateApiTests` in the [POM file](./tests/pom.xml)\n   * Move the generated classes from `/target/generated-sources/openapi/src/test/` to [`/src`](./tests/src/test/java/com/mastercard/openbanking/client/api)\n   * Update the generated test methods\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmastercard%2Fopen-banking-us-openapi","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmastercard%2Fopen-banking-us-openapi","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmastercard%2Fopen-banking-us-openapi/lists"}