MoneyKit API
Project description
MoneyKit
MoneyKit is the next generation connection for the world's money.
This is an autogenerated python SDK for OpenFGA. It provides a wrapper around the MoneyKit API definition.
Installation & Usage
Poetry
Install via Poetry.
poetry add moneykit
Then import the package:
import moneykit
pip install
pip install moneykit
Then import the package:
import moneykit
Getting Started
Please follow the installation procedure and then run the following:
import time
import moneykit
from moneykit.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://api.moneykit.com
# See configuration.py for a list of all supported configuration parameters.
configuration = moneykit.Configuration(
host = "https://api.moneykit.com"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure HTTP basic authorization: HTTPBasic
configuration = moneykit.Configuration(
username = os.environ["USERNAME"],
password = os.environ["PASSWORD"]
)
# Enter a context with an instance of the API client
with moneykit.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = moneykit.AccessTokenApi(api_client)
moneykit_version = '2023-02-18' # str | (optional) (default to '2023-02-18')
grant_type = 'grant_type_example' # str | Token grant type. Only `client_credentials` supported. (optional)
scope = '' # str | Actions to be allowed for this token, given as one or more strings separated by spaces. If omitted, all actions allowed for your application will be granted to this token. (optional) (default to '')
client_id = 'client_id_example' # str | Your application's MoneyKit client ID. (optional)
client_secret = 'client_secret_example' # str | Your application's MoneyKit client secret. (optional)
try:
# /auth/token
api_response = api_instance.generate_access_token(moneykit_version=moneykit_version, grant_type=grant_type, scope=scope, client_id=client_id, client_secret=client_secret)
print("The response of AccessTokenApi->generate_access_token:\n")
pprint(api_response)
except ApiException as e:
print("Exception when calling AccessTokenApi->generate_access_token: %s\n" % e)
Documentation for API Endpoints
All URIs are relative to https://api.moneykit.com
Class | Method | HTTP request | Description |
---|---|---|---|
AccessTokenApi | generate_access_token | POST /auth/token | /auth/token |
AccessTokenApi | get_well_known_jwks | GET /.well-known/jwks.json | JSON Web Key Set |
AccessTokenApi | instrospect_client | GET /auth/introspect | /auth/introspect |
AccountNumbersApi | get_account_numbers | GET /links/{id}/accounts/numbers | /links/{id}/accounts/numbers |
AccountsApi | get_account | GET /links/{id}/accounts/{account_id} | /links/{id}/accounts/{account_id} |
AccountsApi | get_account_numbers | GET /links/{id}/accounts/numbers | /links/{id}/accounts/numbers |
AccountsApi | get_accounts | GET /links/{id}/accounts | /links/{id}/accounts |
AccountsApi | get_user_accounts | GET /users/{id}/accounts | /users/{id}/accounts |
IdentityApi | get_identities | GET /links/{id}/identity | /links/{id}/identity |
InstitutionsApi | get_institution | GET /institutions/{institution_id} | /institutions/{institution_id} |
InstitutionsApi | get_institutions | GET /institutions | /institutions |
LinkSessionApi | create_link_session | POST /link-session | /link-session |
LinkSessionApi | exchange_token | POST /link-session/exchange-token | /link-session/exchange-token |
LinksApi | disconnect | DELETE /links/{id} | /links/{id} |
LinksApi | get_link | GET /links/{id} | /links/{id} |
LinksApi | get_user_links | GET /users/{id}/links | /users/{id}/links |
LinksApi | reset_login | POST /links/{id}/reset | Force a "relink required" state on a link (Test only). |
LinksApi | update_link | PATCH /links/{id} | /links/{id} |
ProductsApi | refresh_products | POST /links/{id}/products | /links/{id}/products |
TransactionsApi | get_transactions | GET /links/{id}/transactions | /links/{id}/transactions |
TransactionsApi | get_transactions_diff | GET /links/{id}/transactions/sync | /links/{id}/transactions/sync |
TransactionsApi | get_user_transactions | GET /users/{id}/transactions | /users/{id}/transactions |
UsersApi | get_user_accounts | GET /users/{id}/accounts | /users/{id}/accounts |
UsersApi | get_user_links | GET /users/{id}/links | /users/{id}/links |
UsersApi | get_user_transactions | GET /users/{id}/transactions | /users/{id}/transactions |
WebhooksApi | trigger_test_link_webhook_event | POST /webhooks/test/link/{id} | Trigger a test webhook event for a link (Sandbox only). |
Documentation For Models
- APIErrorAuthExpiredAccessTokenResponse
- APIErrorAuthUnauthorizedResponse
- APIErrorRateLimitExceededResponse
- Account
- AccountBalances
- AccountGroup
- AccountIdentity
- AccountNumbers
- AccountNumbersLinkProduct
- AccountNumbersProductSettings
- AccountWithAccountNumbers
- AccountsLinkProduct
- AchNumber
- Address
- BacsNumber
- BasicAccountDetails
- Country
- CreateLinkSessionRequest
- CreateLinkSessionResponse
- Currency
- CursorPagination
- CustomerApp
- EftNumber
- ExchangeTokenRequest
- ExchangeTokenResponse
- GenerateAccessTokenResponse
- GetAccountNumbersResponse
- GetAccountResponse
- GetAccountsResponse
- GetInstitutionsResponse
- GetTransactionsResponse
- GetUserAccountsResponse
- GetUserLinksResponse
- GetUserTransactionsResponse
- HTTPValidationError
- IdentityLinkProduct
- IdentityProductSettings
- IdentityResponse
- Institution
- InstitutionErrorNotFoundResponse
- InternationalNumber
- IntrospectClientResponse
- InvestmentsProductSettings
- JWKSet
- LinkCommon
- LinkErrorBadConfigResponse
- LinkErrorBadStateResponse
- LinkErrorDeletedResponse
- LinkErrorForbiddenActionResponse
- LinkErrorNotFoundResponse
- LinkErrorUnauthorizedAccessResponse
- LinkPermissionScope
- LinkPermissions
- LinkProducts
- LinkResponse
- LinkSessionCustomerUser
- LinkSessionCustomerUserEmail
- LinkSessionCustomerUserPhone
- LinkSessionErrorForbiddenConfigResponse
- LinkSessionErrorInvalidTokenExchange
- LinkSessionSettingOverrides
- LinkState
- LinkStateChangedWebhook
- MoneyKitConnectFeatures
- Owner
- PhoneNumber
- PhoneNumberType
- Product
- ProductsSettings
- Provider
- PublicLinkError
- RefreshProductsRequest
- RequestedLinkPermission
- Response401DisconnectLinksIdDelete
- Response401ExchangeTokenLinkSessionExchangeTokenPost
- Response401GetAccountLinksIdAccountsAccountIdGet
- Response401GetAccountNumbersLinksIdAccountsNumbersGet
- Response401GetAccountsLinksIdAccountsGet
- Response401GetIdentitiesLinksIdIdentityGet
- Response401GetInstitutionInstitutionsInstitutionIdGet
- Response401GetInstitutionsInstitutionsGet
- Response401GetLinkLinksIdGet
- Response401GetTransactionsDiffLinksIdTransactionsSyncGet
- Response401GetTransactionsLinksIdTransactionsGet
- Response401GetUserAccountsUsersIdAccountsGet
- Response401GetUserLinksUsersIdLinksGet
- Response401GetUserTransactionsUsersIdTransactionsGet
- Response401GetWellKnownJwksWellKnownJwksJsonGet
- Response401InstrospectClientAuthIntrospectGet
- Response401RefreshProductsLinksIdProductsPost
- Response401ResetLoginLinksIdResetPost
- Response401TriggerTestLinkWebhookEventWebhooksTestLinkIdPost
- Response401UpdateLinkLinksIdPatch
- Transaction
- TransactionDiff
- TransactionSyncResponse
- TransactionType
- TransactionTypeFilter
- TransactionsLinkProduct
- TransactionsProductSettings
- UpdateLinkRequest
- ValidationError
- ValidationErrorLocationInner
- WebhookLinkTestEvent
- WebhookTestLinkRequest
- WebhookTestLinkResponse
Documentation For Authorization
Authentication schemes defined for the API:
OAuth2ClientCredentials
- Type: OAuth
- Flow: application
- Authorization URL:
- Scopes:
- link_session:create: Client can create a Link Session for Connect SDKs
- link_session:tags:moneykit_reserved: Client can use Link tags that contain reserved MoneyKit prefixes
- link_session:features:issue_reporter: Client can enable in-sdk issue reporter on a Link Session
- link_session:features:bug_reporter: Client can enable in-sdk (internal QA) bug reporter on a Link Session
- link_session:features:money_id: Client can enable in-sdk Money ID login/registration on a Link Session
- link_session:features:device_verification: Client can enable in-sdk device verification (via Prove)
- link_session:features:provider_sandbox_institutions: Client can select non-MoneyKit institutions in sandbox
- link_session:features:simulate_provider_error: Client can force providers to fail during the link flow
- link:data:read: Client can read all data associated with a Link (accounts, transactions, auth, identity etc)
- link:data:refresh: Client can trigger a manual refresh of data associated with a Link
- link:delete: Client can delete a Link
- link:product:investments: Client can access investments products
- institutions:read: Client can fetch institutions
- institutions:assets:read: Client can include assets when fetching institutions
- api_compatibility:plaid: Client can access Plaid compatible API layer
HTTPBasic
- Type: HTTP basic authentication
Author
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
moneykit-0.1.0a1.tar.gz
(69.0 kB
view hashes)
Built Distribution
moneykit-0.1.0a1-py3-none-any.whl
(221.5 kB
view hashes)
Close
Hashes for moneykit-0.1.0a1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8dfde96b7dfa10561f2ed78e59d8fd338bef55d50cc8b3b2d8fa4141e43620f3 |
|
MD5 | 5c38f3f06e199dade35289770a2a705d |
|
BLAKE2b-256 | 429fd7075299e05bbcb181f33184db11247ce2e5f841e8bb19b0e3737b4a295c |