# Mastercard Open Banking API

> Mastercard Open Banking API on Apizie: 104 endpoints (Create Access Token, Modify Partner Secret, Generate Connect URL, Generate Lite Connect URL, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://www.apizie.tech/v1/finance:mastercard/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `finance:mastercard`
- Category: Finance
- Status: byok
- Source: https://finicity.com
- Page: https://www.apizie.tech/api/finance/mastercard
- OpenAPI: https://www.apizie.tech/api/finance/mastercard/openapi.json

OpenAPI specification for Finicity APIs. Open Banking solutions in the US are provided by Finicity, a Mastercard company.

## Endpoints

### Create Access Token
`POST https://www.apizie.tech/v1/finance:mastercard/authentication-create-access-token` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Modify Partner Secret
`POST https://www.apizie.tech/v1/finance:mastercard/authentication-modify-partner-secret` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Generate Connect URL
`POST https://www.apizie.tech/v1/finance:mastercard/connect-generate-url` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Generate Lite Connect URL
`POST https://www.apizie.tech/v1/finance:mastercard/connect-generate-lite-url` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Generate Fix Connect URL
`POST https://www.apizie.tech/v1/finance:mastercard/connect-fix-url-generation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Send Connect Email
`POST https://www.apizie.tech/v1/finance:mastercard/connect-send-connect-email` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Generate Connect URL - Joint Borrower
`POST https://www.apizie.tech/v1/finance:mastercard/connect-generate-joint-borrower-url` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Account Validation Assistant User verification of microdeposits
`POST https://www.apizie.tech/v1/finance:mastercard/connect-verify-micro-entry-microdeposits` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Send Connect Email - Joint Borrower
`POST https://www.apizie.tech/v1/finance:mastercard/connect-send-email-joint-borrower` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Add Testing Customer
`POST https://www.apizie.tech/v1/finance:mastercard/customers-enroll-testing-customer` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Add Customer
`POST https://www.apizie.tech/v1/finance:mastercard/customers-enroll-active-customer` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Get Customers
`GET https://www.apizie.tech/v1/finance:mastercard/customers-find-enrolled-users` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| username | string | no | Username for exact match (will return 0 or 1 record) |
| type | string | no | "testing" or "active" to return only customers of that type, or leave empty to return all customers |
| search | string | no | The text you wish to match. Leave this empty if you wish to return all customers. Must be URL-encoded (see: [Handling Spaces in… |
| start | integer | no | Index of the page of results to return |
| limit | integer | no | Maximum number of results per page |

### Get Customer With App Data by ID
`GET https://www.apizie.tech/v1/finance:mastercard/customers-get-with-app-data-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| customerId | string | yes | A customer ID |

### Get Customer by ID
`GET https://www.apizie.tech/v1/finance:mastercard/customers-get-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| customerId | string | yes | A customer ID |

### Modify Customer by ID
`POST https://www.apizie.tech/v1/finance:mastercard/customers-modify-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| customerId | string | yes | A customer ID |
| body | object | yes | JSON request body |

### Delete Customer by ID
`POST https://www.apizie.tech/v1/finance:mastercard/customers-remove-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| customerId | string | yes | A customer ID |

### Get Consumer For Customer
`GET https://www.apizie.tech/v1/finance:mastercard/consumers-get-by-customer-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| customerId | string | yes | A customer ID |

### Create Consumer
`POST https://www.apizie.tech/v1/finance:mastercard/consumers-create-consumer-record` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| customerId | string | yes | A customer ID |
| body | object | yes | JSON request body |

### Get Consumer by ID
`GET https://www.apizie.tech/v1/finance:mastercard/consumers-get-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| consumerId | string | yes | The consumer ID |

### Modify Consumer by ID
`POST https://www.apizie.tech/v1/finance:mastercard/consumers-modify-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| consumerId | string | yes | The consumer ID |
| body | object | yes | JSON request body |

### Get Customer Accounts by Institution Login ID
`GET https://www.apizie.tech/v1/finance:mastercard/accounts-get-by-institution-login` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| customerId | string | yes | A customer ID |
| institutionLoginId | string | yes | The institution login ID |

### Refresh Customer Accounts by Institution Login ID
`POST https://www.apizie.tech/v1/finance:mastercard/accounts-refresh-customer-by-institution-login` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| customerId | string | yes | A customer ID |
| institutionLoginId | string | yes | The institution login ID |

### Refresh Customer Account by Institution Login ID for Data Access Tiers
`POST https://www.apizie.tech/v1/finance:mastercard/accounts-refresh-customer-account-by-institution-login` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| customerId | string | yes | A customer ID |
| institutionLoginId | string | yes | The institution login ID |

### Delete Customer Accounts by Institution Login ID
`POST https://www.apizie.tech/v1/finance:mastercard/accounts-remove-by-institution-login` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| customerId | string | yes | A customer ID |
| institutionLoginId | string | yes | The institution login ID |

### Get Customer Account by ID
`GET https://www.apizie.tech/v1/finance:mastercard/accounts-get-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| customerId | string | yes | A customer ID |
| accountId | string | yes | The account ID |

### Delete Customer Account by ID
`POST https://www.apizie.tech/v1/finance:mastercard/accounts-remove-by-customer-id-and-account-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| customerId | string | yes | A customer ID |
| accountId | string | yes | The account ID |

### Get Customer Accounts
`GET https://www.apizie.tech/v1/finance:mastercard/accounts-get-customer-accounts` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| customerId | string | yes | A customer ID |
| status | string | no | A filter to fetch account in the given status |
| account_type | string | no | A filter to fetch accounts for the given type. Currently supported types: "ava" |

### Refresh Customer Accounts
`POST https://www.apizie.tech/v1/finance:mastercard/accounts-refresh-customer-aggregation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| customerId | string | yes | A customer ID |

### Refresh Customer Accounts for Data Access Tiers
`POST https://www.apizie.tech/v1/finance:mastercard/accounts-refresh-customer-data` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| customerId | string | yes | A customer ID |

### Get Customer Accounts by Institution ID
`GET https://www.apizie.tech/v1/finance:mastercard/accounts-get-customer-institution-accounts` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| customerId | string | yes | A customer ID |
| institutionId | integer | yes | The institution ID |

### Get Customer Accounts by Institution ID (Simple)
`GET https://www.apizie.tech/v1/finance:mastercard/accounts-simple-get-basic-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| customerId | string | yes | A customer ID |
| institutionId | integer | yes | The institution ID |

### Get Customer Accounts by Institution Login ID (Simple)
`GET https://www.apizie.tech/v1/finance:mastercard/accounts-simple-get-basic-info-2` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| customerId | string | yes | A customer ID |
| institutionLoginId | string | yes | The institution login ID |

### Get Customer Account by ID (Simple)
`GET https://www.apizie.tech/v1/finance:mastercard/accounts-simple-get-basic-info-3` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| customerId | string | yes | A customer ID |
| accountId | string | yes | The account ID |

### Get Customer Accounts (Simple)
`GET https://www.apizie.tech/v1/finance:mastercard/accounts-simple-get-basic-info-4` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| customerId | string | yes | A customer ID |

### Load Historic Transactions for Customer Account
`POST https://www.apizie.tech/v1/finance:mastercard/transactions-load-historic-transactions-for-customer-account` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| customerId | string | yes | A customer ID |
| accountId | string | yes | The account ID |

### Get Account Owner
`GET https://www.apizie.tech/v1/finance:mastercard/payments-get-account-owner-details` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| customerId | string | yes | A customer ID |
| accountId | string | yes | The account ID |

### Get Account Owner Details
`GET https://www.apizie.tech/v1/finance:mastercard/payments-get-account-owner-details-2` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| customerId | string | yes | A customer ID |
| accountId | string | yes | The account ID |
| withInsights | boolean | no | If this parameter is true, Identity Insights data will be returned along with the account owner information |

### Register App
`POST https://www.apizie.tech/v1/finance:mastercard/app-registration-create-new-application` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Modify App Registration
`POST https://www.apizie.tech/v1/finance:mastercard/app-registration-update-registration` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| preAppId | string | yes | The application registration tracking ID |
| body | object | yes | JSON request body |

### Get App Registration Status
`GET https://www.apizie.tech/v1/finance:mastercard/app-registration-get-application-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| preAppId | string | no | The application registration tracking ID |
| applicationId | string | no | The application ID |
| status | string | no | Look up app registration requests by status |
| appName | string | no | Look up app registration requests by app name |
| submittedDate | integer | no | Look up app registration requests by the date they were submitted |
| modifiedDate | integer | no | Look up app registration requests by the date the request was updated. This can be used to determine when a request was updated to "A" or… |
| page | integer | no | Index of the page of results to return |
| pageSize | integer | no | Maximum number of results per page |

### Set Customer App ID
`POST https://www.apizie.tech/v1/finance:mastercard/app-registration-assign-applications` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| customerId | string | yes | A customer ID |
| applicationId | string | yes | The application ID |

### Migrate Institution Login Accounts
`POST https://www.apizie.tech/v1/finance:mastercard/app-registration-migrate-institution-login-accounts` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| customerId | string | yes | A customer ID |
| institutionLoginId | string | yes | The institution login ID |

### Get Certified Institutions With RSSD
`GET https://www.apizie.tech/v1/finance:mastercard/institutions-get-certified-institutions-with-rssd` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| search | string | no | Search term (financial institution `name` field). Leave empty for all FIs. |
| start | integer | no | Index of the page of results to return |
| limit | integer | no | Maximum number of results per page |
| type | string | no | A product type: "transAgg", "ach", "stateAgg", "voi", "voa", "aha", "availBalance", "accountOwner" |
| supportedCountries | array | no | A list of country codes, '*' for all countries. |

### Get Institutions
`GET https://www.apizie.tech/v1/finance:mastercard/institutions-search-financial-institutions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| search | string | no | Search term (financial institution `name` field). Leave empty for all FIs. |
| start | integer | no | Index of the page of results to return |
| limit | integer | no | Maximum number of results per page |
| type | string | no | A product type: "transAgg", "ach", "stateAgg", "voi", "voa", "aha", "availBalance", "accountOwner" |
| supportedCountries | array | no | A list of country codes, '*' for all countries. |

### Get Certified Institutions
`GET https://www.apizie.tech/v1/finance:mastercard/institutions-list-certified-institutions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| search | string | no | Search term (financial institution `name` field). Leave empty for all FIs. |
| start | integer | no | Index of the page of results to return |
| limit | integer | no | Maximum number of results per page |
| type | string | no | A product type: "transAgg", "ach", "stateAgg", "voi", "voa", "aha", "availBalance", "accountOwner" |
| supportedCountries | array | no | A list of country codes, '*' for all countries. |

### Get Institution by ID
`GET https://www.apizie.tech/v1/finance:mastercard/institutions-get-by-id-details` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| institutionId | integer | yes | The institution ID |

### Get Institution Branding by ID
`GET https://www.apizie.tech/v1/finance:mastercard/institutions-get-branding-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| institutionId | integer | yes | The institution ID |

### Generate VOA Report
`POST https://www.apizie.tech/v1/finance:mastercard/verify-assets-customer-voareport` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| customerId | string | yes | A customer ID |
| callbackUrl | string | no | A Report Listener URL to receive notifications. The webhook must respond to the Finicity API with a 2xx HTTP status code. |
| body | object | yes | JSON request body |

### Generate VOA With Income Report
`POST https://www.apizie.tech/v1/finance:mastercard/verify-assets-generate-voawith-income-report` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| customerId | string | yes | A customer ID |
| callbackUrl | string | no | A Report Listener URL to receive notifications. The webhook must respond to the Finicity API with a 2xx HTTP status code. |
| body | object | yes | JSON request body |

### Generate Prequalification (CRA) Report
`POST https://www.apizie.tech/v1/finance:mastercard/verify-assets-get-checking-savings-investment-accounts` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| customerId | string | yes | A customer ID |
| callbackUrl | string | no | A Report Listener URL to receive notifications. The webhook must respond to the Finicity API with a 2xx HTTP status code. |
| body | object | yes | JSON request body |

### Generate Prequalification (Non-CRA) Report
`POST https://www.apizie.tech/v1/finance:mastercard/verify-assets-get-asset-summary` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| customerId | string | yes | A customer ID |
| callbackUrl | string | no | A Report Listener URL to receive notifications. The webhook must respond to the Finicity API with a 2xx HTTP status code. |
| body | object | yes | JSON request body |

### Generate VOI Report
`POST https://www.apizie.tech/v1/finance:mastercard/verify-income-and-employment-create-voireport` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| customerId | string | yes | A customer ID |
| callbackUrl | string | no | A Report Listener URL to receive notifications. The webhook must respond to the Finicity API with a 2xx HTTP status code. |
| body | object | yes | JSON request body |

### Generate VOE - Payroll Report
`POST https://www.apizie.tech/v1/finance:mastercard/verify-income-and-employment-generate-voe-payroll-report` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| customerId | string | yes | A customer ID |
| callbackUrl | string | no | A Report Listener URL to receive notifications. The webhook must respond to the Finicity API with a 2xx HTTP status code. |
| body | object | yes | JSON request body |

### Generate VOE - Transactions Report
`POST https://www.apizie.tech/v1/finance:mastercard/verify-income-and-employment-generate-voetransactions-report` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| customerId | string | yes | A customer ID |
| callbackUrl | string | no | A Report Listener URL to receive notifications. The webhook must respond to the Finicity API with a 2xx HTTP status code. |
| body | object | yes | JSON request body |

### Generate Pay Statement Report
`POST https://www.apizie.tech/v1/finance:mastercard/verify-income-and-employment-generate-pay-statement-report` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| customerId | string | yes | A customer ID |
| callbackUrl | string | no | A Report Listener URL to receive notifications. The webhook must respond to the Finicity API with a 2xx HTTP status code. |
| body | object | yes | JSON request body |

### Generate VOIE - Paystub (with TXVerify) Report
`POST https://www.apizie.tech/v1/finance:mastercard/verify-income-and-employment-generate-voiepaystub-with-tx-ve` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| customerId | string | yes | A customer ID |
| callbackUrl | string | no | A Report Listener URL to receive notifications. The webhook must respond to the Finicity API with a 2xx HTTP status code. |
| body | object | yes | JSON request body |

### Generate VOIE - Paystub Report
`POST https://www.apizie.tech/v1/finance:mastercard/verify-income-and-employment-generate-voie-paystub-report` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| customerId | string | yes | A customer ID |
| callbackUrl | string | no | A Report Listener URL to receive notifications. The webhook must respond to the Finicity API with a 2xx HTTP status code. |
| body | object | yes | JSON request body |

### Generate VOIE - Payroll Report
`POST https://www.apizie.tech/v1/finance:mastercard/verify-income-and-employment-refresh-voiepayroll-report` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| customerId | string | yes | A customer ID |
| callbackUrl | string | no | A Report Listener URL to receive notifications. The webhook must respond to the Finicity API with a 2xx HTTP status code. |
| body | object | yes | JSON request body |

### Get Customer Account Statement
`GET https://www.apizie.tech/v1/finance:mastercard/bank-statements-get-customer-statement-in-pdf` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| customerId | string | yes | A customer ID |
| accountId | string | yes | The account ID |
| index | integer | no | Request statements from 1-24. By default, 1 is the most recent statement. Increase the index value to count back (by month) and retrieve… |
| type | string | no | The type of statement to retrieve |

### Generate Statement Report
`POST https://www.apizie.tech/v1/finance:mastercard/bank-statements-generate-report` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| customerId | string | yes | A customer ID |
| callbackUrl | string | no | A Report Listener URL to receive notifications. The webhook must respond to the Finicity API with a 2xx HTTP status code. |
| body | object | yes | JSON request body |

### Get Customer Account Multiple Statements
`GET https://www.apizie.tech/v1/finance:mastercard/bank-statements-get-multiple-statements` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| customerId | string | yes | A customer ID |
| accountId | string | yes | The account ID |
| index | string | no | Request statements with comma-separated indexes between 1-24. The default value is 1 and it will return the most recent statement.… |

### Get All Customer Transactions
`GET https://www.apizie.tech/v1/finance:mastercard/transactions-get-all-customer-transactions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| customerId | string | yes | A customer ID |
| fromDate | integer | yes | A start date |
| toDate | integer | yes | A end date |
| start | integer | no | Index of the page of results to return |
| limit | integer | no | Maximum number of results per page |
| sort | string | no | Date sort order: "asc" for ascending, "desc" for descending |
| includePending | boolean | no | If pending transactions must be included |

### Get Customer Transaction by ID
`GET https://www.apizie.tech/v1/finance:mastercard/transactions-get-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| customerId | string | yes | A customer ID |
| transactionId | integer | yes | A transaction ID |

### Get Customer Account Transactions
`GET https://www.apizie.tech/v1/finance:mastercard/transactions-get-customer-account-transactions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| customerId | string | yes | A customer ID |
| accountId | string | yes | The account ID |
| fromDate | integer | yes | A start date |
| toDate | integer | yes | A end date |
| start | integer | no | Index of the page of results to return |
| limit | integer | no | Maximum number of results per page |
| sort | string | no | Date sort order: "asc" for ascending, "desc" for descending |
| includePending | boolean | no | If pending transactions must be included |

### Generate Transactions Report
`POST https://www.apizie.tech/v1/finance:mastercard/transactions-get24-months-history-and-generate-report` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| callbackUrl | string | no | A Report Listener URL to receive notifications. The webhook must respond to the Finicity API with a 2xx HTTP status code. |
| customerId | string | yes | A customer ID |
| toDate | integer | yes | A end date |
| includePending | boolean | no | If pending transactions must be included |
| body | object | yes | JSON request body |

### Generate Balance Analytics Report - Personal/Business
`POST https://www.apizie.tech/v1/finance:mastercard/balance-analytics-generate-report` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| customerId | string | yes | A customer ID |
| userType | string | yes | UserType indicates if the request is for a business or personal use case, Allowed values: business/personal. |
| callbackUrl | string | no | A Report Listener URL to receive notifications. The webhook must respond to the Finicity API with a 2xx HTTP status code. |
| body | object | yes | JSON request body |

### Generate Cashflow Analytics Report - Personal/Business
`POST https://www.apizie.tech/v1/finance:mastercard/cash-flow-analytics-generate-report` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| customerId | string | yes | A customer ID |
| userType | string | yes | UserType indicates if the request is for a business or personal use case, Allowed values: business/personal. |
| callbackUrl | string | no | A Report Listener URL to receive notifications. The webhook must respond to the Finicity API with a 2xx HTTP status code. |
| body | object | yes | JSON request body |

### Store Customer Pay Statement
`POST https://www.apizie.tech/v1/finance:mastercard/pay-statements-upload-for-customer` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| customerId | string | yes | A customer ID |
| body | object | yes | JSON request body |

### Get Loan Payment Details
`GET https://www.apizie.tech/v1/finance:mastercard/payments-get-loan-payment-details` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| customerId | string | yes | A customer ID |
| accountId | string | yes | The account ID |

### Get Portfolio by Customer
`GET https://www.apizie.tech/v1/finance:mastercard/portfolios-get-most-recent-reports` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| customerId | string | yes | A customer ID |
| portfolioId | string | yes | A portfolio ID with the portfolio version number. Using the portfolio number without a version number will return the most recently… |

### Subscribe to TxPush Notifications
`POST https://www.apizie.tech/v1/finance:mastercard/tx-push-subscribe-notifications` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| customerId | string | yes | A customer ID |
| accountId | string | yes | The account ID |
| body | object | yes | JSON request body |

### Disable TxPush Notifications
`POST https://www.apizie.tech/v1/finance:mastercard/tx-push-disable-notifications` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| customerId | string | yes | A customer ID |
| accountId | string | yes | The account ID |

### Create TxPush Test Transaction
`POST https://www.apizie.tech/v1/finance:mastercard/tx-push-inject-test-transaction` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| customerId | string | yes | A customer ID |
| accountId | string | yes | The account ID |
| body | object | yes | JSON request body |

### Delete TxPush Subscription
`POST https://www.apizie.tech/v1/finance:mastercard/tx-push-delete-subscription` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| customerId | string | yes | A customer ID |
| subscriptionId | integer | yes | The subscription ID |

### Get Portfolio by Consumer
`GET https://www.apizie.tech/v1/finance:mastercard/portfolios-get-portfolio-by-consumer` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| consumerId | string | yes | The consumer ID |
| portfolioId | string | yes | A portfolio ID with the portfolio version number. Using the portfolio number without a version number will return the most recently… |

### Get Account ACH Details
`GET https://www.apizie.tech/v1/finance:mastercard/payments-get-ach-details` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| customerId | string | yes | A customer ID |
| accountId | string | yes | The account ID |

### Get Report by Customer and ID
`GET https://www.apizie.tech/v1/finance:mastercard/reports-get-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| customerId | string | yes | A customer ID |
| reportId | string | yes | ID of the report |
| onBehalfOf | string | no | The name of the entity you are retrieving the report on behalf of |
| purpose | string | no | 2-digit code from [Permissible Purpose… |

### Get Report by Consumer and ID
`GET https://www.apizie.tech/v1/finance:mastercard/reports-get-by-consumer-and-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| purpose | string | no | 2-digit code from [Permissible Purpose… |
| consumerId | string | yes | The consumer ID |
| reportId | string | yes | ID of the report |
| onBehalfOf | string | no | The name of the entity you are retrieving the report on behalf of |

### Get Reports by Customer ID
`GET https://www.apizie.tech/v1/finance:mastercard/reports-by-customer-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| customerId | string | yes | A customer ID |
| purpose | string | no | 2-digit code from [Permissible Purpose… |

### Get Reports by Consumer ID
`GET https://www.apizie.tech/v1/finance:mastercard/reports-by-consumer-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| purpose | string | no | 2-digit code from [Permissible Purpose… |
| consumerId | string | yes | The consumer ID |

### Get Asset by Customer and ID
`GET https://www.apizie.tech/v1/finance:mastercard/assets-get-binary-file` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| customerId | string | yes | A customer ID |
| assetId | string | yes | The asset ID |

### Get Available Balance - Live
`GET https://www.apizie.tech/v1/finance:mastercard/payments-get-available-balance-live` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| customerId | string | yes | A customer ID |
| accountId | string | yes | The account ID |

### Get Available Balance
`GET https://www.apizie.tech/v1/finance:mastercard/payments-get-latest-cached-balance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| customerId | string | yes | A customer ID |
| accountId | string | yes | The account ID |

### Generate Cash Flow Report - Business
`POST https://www.apizie.tech/v1/finance:mastercard/cash-flow-generate-report-business` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| customerId | string | yes | A customer ID |
| callbackUrl | string | no | A Report Listener URL to receive notifications. The webhook must respond to the Finicity API with a 2xx HTTP status code. |
| body | object | yes | JSON request body |

### Generate Cash Flow Report - Personal
`POST https://www.apizie.tech/v1/finance:mastercard/cash-flow-generate-personal-report` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| customerId | string | yes | A customer ID |
| callbackUrl | string | no | A Report Listener URL to receive notifications. The webhook must respond to the Finicity API with a 2xx HTTP status code. |
| body | object | yes | JSON request body |

### Initiate Micro Entries
`POST https://www.apizie.tech/v1/finance:mastercard/account-validation-assistance-initiate-micro-entries` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| customerId | string | yes | A customer ID |
| body | object | yes | JSON request body |

### Verify Micro Entries
`POST https://www.apizie.tech/v1/finance:mastercard/account-validation-assistance-verify-micro-entries` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| customerId | string | yes | A customer ID |
| accountId | string | yes | The account ID |
| body | object | yes | JSON request body |

### Get Micro Entries Details
`GET https://www.apizie.tech/v1/finance:mastercard/account-validation-assistance-get-micro-entries-details` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| customerId | string | yes | A customer ID |
| accountId | string | yes | The account ID |

### Generate Balance Analytics
`POST https://www.apizie.tech/v1/finance:mastercard/balance-analytics-generate-analytics-report` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| customerId | string | yes | A customer ID |
| reference-number | string | no | Partner-provided reference number to correlate reports. |
| body | object | yes | JSON request body |

### Generate Balance Analytics - FCRA
`POST https://www.apizie.tech/v1/finance:mastercard/balance-analytics-generate-fcra-analytics-report` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| customerId | string | yes | A customer ID |
| reference-number | string | no | Partner-provided reference number to correlate reports. |
| body | object | yes | JSON request body |

### Generate Cash Flow Analytics
`POST https://www.apizie.tech/v1/finance:mastercard/cash-flow-analytics-generate-analytics` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| customerId | string | yes | A customer ID |
| reference-number | string | no | Partner-provided reference number to correlate reports. |
| body | object | yes | JSON request body |

### Generate Cash Flow Analytics - FCRA
`POST https://www.apizie.tech/v1/finance:mastercard/cash-flow-analytics-generate-fcra-analytics-report` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| customerId | string | yes | A customer ID |
| reference-number | string | no | Partner-provided reference number to correlate reports. |
| body | object | yes | JSON request body |

### Generate Payment History
`POST https://www.apizie.tech/v1/finance:mastercard/payment-history-generate-customer-payment-report` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| customerId | string | yes | A customer ID |
| reference-number | string | no | Partner-provided reference number to correlate reports. |

### Generate Payment History - FCRA
`POST https://www.apizie.tech/v1/finance:mastercard/payment-history-generate-fcra-payment-report` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| customerId | string | yes | A customer ID |
| reference-number | string | no | Partner-provided reference number to correlate reports. |

### Get OBB Analytics Report
`GET https://www.apizie.tech/v1/finance:mastercard/balance-analytics-get-report-data` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| obb_report_id | string | yes | Report ID generated and returned by OBB products |

### Get OBB Analytics Report - FCRA
`GET https://www.apizie.tech/v1/finance:mastercard/balance-analytics-get-report-data-fcra` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| obb_report_id | string | yes | Report ID generated and returned by OBB products |
| purpose | string | yes | 2-digit code from [Permissible Purpose… |

### Generate Third Party Access Key
`POST https://www.apizie.tech/v1/finance:mastercard/third-party-access-generate-key` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Update Third Party Access
`POST https://www.apizie.tech/v1/finance:mastercard/third-party-access-update-access` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| consentReceiptId | string | yes | Third party access key receipt ID |
| body | object | yes | JSON request body |

### Revoke Third Party Access
`POST https://www.apizie.tech/v1/finance:mastercard/third-party-access-revoke-partners-access` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| consentReceiptId | string | yes | Third party access key receipt ID |

### Get Business for Customer
`GET https://www.apizie.tech/v1/finance:mastercard/businesses-api-get-details-by-customer-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| customer_id | string | yes | Unique identifier of the customer |

### Create a New Business for a Customer
`POST https://www.apizie.tech/v1/finance:mastercard/businesses-api-create-new-business` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| customer_id | string | yes | Unique identifier of the customer |
| body | object | yes | JSON request body |

### Get Business by ID
`GET https://www.apizie.tech/v1/finance:mastercard/businesses-api-get-details-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| business_id | string | yes | Unique identifier of the business |

### Update Business by ID
`POST https://www.apizie.tech/v1/finance:mastercard/businesses-api-update-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| business_id | string | yes | Unique identifier of the business |
| body | object | yes | JSON request body |

### Get ACH Account Details
`GET https://www.apizie.tech/v1/finance:mastercard/payments-get-ach-account-details` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| customerId | string | yes | A customer ID |
| accountId | string | yes | The account ID |

## Example
```
curl "https://www.apizie.tech/v1/finance:mastercard/authentication-create-access-token" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Mastercard Open Banking API?
Create a free Apizie key, then send POST https://www.apizie.tech/v1/finance:mastercard/authentication-create-access-token with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Mastercard Open Banking API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Mastercard Open Banking itself also needs your own key from api.finicity.com.

### Can AI agents use the Mastercard Open Banking API?
Yes. Add the Apizie MCP server (https://www.apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key finance:mastercard.

### What is the status of the Mastercard Open Banking API?
Needs your own provider key (bring your own key)