Skip to content

nook-io/python-yapily

BranchesTags

Repository files navigation

building the repo

  • Download the latest Yapily openapi.json file
  • Run openapi-generator generate -i openapi.json -g python-pydantic-v1 -o . --additional-properties=projectName=python-yapily,packageName=yapily --library=asyncio
  • Run ruff check --fix and ruff format, fixing any issues.

python-yapily

The Yapily API enables connections between your application and users' banks. For more information check out our documentation.

In particular, make sure to view our Getting Started steps if this is your first time here.

While testing the API, our list of sandbox credentials maybe useful.

This Python package is automatically generated by the OpenAPI Generator project:

Requirements.

Python 3.7+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import yapily

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import yapily

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import time
import yapily
from yapily.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.yapily.com
# See configuration.py for a list of all supported configuration parameters.
configuration = yapily.Configuration(
    host = "https://api.yapily.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: basicAuth
configuration = yapily.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)


# Enter a context with an instance of the API client
async with yapily.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = yapily.ApplicationApi(api_client)

    try:
        # Get Application Self
        api_response = await api_instance.get_application_me()
        print("The response of ApplicationApi->get_application_me:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ApplicationApi->get_application_me: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://api.yapily.com

Class Method HTTP request Description
ApplicationApi get_application_me GET /me Get Application Self
ApplicationManagementApi create_application_vrp_configuration_by_application_id POST /applications/{applicationId}/vrp Create application VRP configuration by Application Id
ApplicationManagementApi create_sub_application POST /applications Creates a sub-application for the root application id provided in the authentication token
ApplicationManagementApi delete_application DELETE /applications/{applicationId} Delete an application
ApplicationManagementApi get_application_by_id GET /applications/{applicationId} Get application details
ApplicationManagementApi get_application_vrp_configuration_by_application_id GET /applications/{applicationId}/vrp Get application VRP configuration by Application Id
ApplicationManagementApi search_applications GET /applications Retrieve sub-applications for the root application provided in the authentication token.
ApplicationManagementApi update_application PUT /applications/{applicationId} Update an Application
ApplicationManagementApi update_application_vrp_configuration_by_application_id PUT /applications/{applicationId}/vrp Update application VRP configuration by Application Id
AuthorisationsApi create_bulk_payment_authorisation POST /bulk-payment-auth-requests Create Bulk Payment Authorisation
AuthorisationsApi create_embedded_bulk_payment_authorisation POST /embedded-bulk-payment-auth-requests Create Embedded Bulk Payment Authorisation
AuthorisationsApi create_embedded_payment_authorisation POST /embedded-payment-auth-requests Create Embedded Payment Authorisation
AuthorisationsApi create_payment_authorisation POST /payment-auth-requests Create Payment Authorisation
AuthorisationsApi create_payment_pre_authorisation_request POST /payment-pre-auth-requests Create Payment Pre-authorisation
AuthorisationsApi create_pre_authorisation_request POST /pre-auth-requests Create Pre-authorisation
AuthorisationsApi initiate_account_request POST /account-auth-requests Create Account Authorisation
AuthorisationsApi initiate_embedded_account_request POST /embedded-account-auth-requests Create Embedded Account Authorisation
AuthorisationsApi re_authorise_account PATCH /account-auth-requests Re-authorise Account Consent
AuthorisationsApi update_embedded_account_request PUT /embedded-account-auth-requests/{consentId} Update Embedded Account Authorisation
AuthorisationsApi update_embedded_bulk_payment_authorisation PUT /embedded-bulk-payment-auth-requests/{consentId} Update Embedded Bulk Payment Authorisation
AuthorisationsApi update_embedded_payment_authorisation PUT /embedded-payment-auth-requests/{consentId} Update Embedded Payment Authorisation
AuthorisationsApi update_payment_authorisation PUT /payment-auth-requests Update Payment Pre-authorisation
AuthorisationsApi update_pre_authorise_account_consent PUT /account-auth-requests Update Account Pre-authorisation
ConsentsApi create_consent_with_code POST /consent-auth-code Exchange OAuth2 Code
ConsentsApi delete DELETE /consents/{consentId} Delete Consent
ConsentsApi extend_consent POST /consents/{consentId}/extend Extend Consent
ConsentsApi get_consent_by_id GET /consents/{consentId} Get Consent
ConsentsApi get_consent_by_single_access_consent POST /consent-one-time-token Exchange One Time Token
ConsentsApi get_consents GET /consents Get Consents
ConstraintsApi get_account_constraints_rules_by_institution GET /institutions/constraints/data Get Data Constraints Rules
ConstraintsApi get_payment_constraints_rules_by_institution GET /institutions/constraints/payments Get Payment Constraints Rules
EnrichmentApi get_accounts_transactions_categorised GET /accounts/{accountId}/transactions/categorisation/{categorisationId} Get Categorised Transactions
EnrichmentApi get_categorisation_account_type GET /transactions/categorisation/categories/{accountType} Get the list of all categories for a specific account type
EnrichmentApi post_accounts_account_id_transactions_categorisation POST /accounts/{accountId}/transactions/categorisation Trigger transaction categorisation
FinancialDataApi get_account GET /accounts/{accountId} Get Account
FinancialDataApi get_account_balances GET /accounts/{accountId}/balances Get Account Balances
FinancialDataApi get_account_direct_debits GET /accounts/{accountId}/direct-debits Get Account Direct Debits
FinancialDataApi get_account_periodic_payments GET /accounts/{accountId}/periodic-payments Get Account Periodic Payments
FinancialDataApi get_account_scheduled_payments GET /accounts/{accountId}/scheduled-payments Get Account Scheduled Payments
FinancialDataApi get_accounts GET /accounts Get Accounts
FinancialDataApi get_beneficiaries GET /accounts/{accountId}/beneficiaries Get Account Beneficiaries
FinancialDataApi get_categories GET /categories/{country} Get Categories
FinancialDataApi get_identity GET /identity Get Identity
FinancialDataApi get_real_time_transactions GET /accounts/{accountId}/real-time/transactions Get Real Time Account Transactions
FinancialDataApi get_statement GET /accounts/{accountId}/statements/{statementId} Get Account Statement
FinancialDataApi get_statement_file GET /accounts/{accountId}/statements/{statementId}/file Get Account Statement File
FinancialDataApi get_statements GET /accounts/{accountId}/statements Get Account Statements
FinancialDataApi get_transactions GET /accounts/{accountId}/transactions Get Account Transactions
FinancialProfileApi create_profile_consent POST /users/{userUuid}/profile/consents Create Profile Consent
FinancialProfileApi delete_profile_consent DELETE /users/{userUuid}/profile/consents/{profileConsentId} Delete Profile Consent
FinancialProfileApi get_balance_prediction GET /users/{userUuid}/profile/predicted-balances Get Predicted Balances
FinancialProfileApi get_profile_consent GET /users/{userUuid}/profile/consents/{profileConsentId} Get Profile Consent
FinancialProfileApi get_user_profile GET /users/{userUuid}/profile/transaction-groups Get Transaction Groups
HostedConsentPagesApi create_hosted_consent_request POST /hosted/consent-requests Create Hosted Consent Request
HostedConsentPagesApi get_hosted_consent_request GET /hosted/consent-requests/{consentRequestId} Get Hosted Consent Request
HostedPaymentPagesApi create_hosted_payment_request POST /hosted/payment-requests Create Hosted payment request
HostedPaymentPagesApi create_hosted_payment_request_link POST /hosted/payment-requests/links Create Pay By Link
HostedPaymentPagesApi create_hosted_vrp_consent_request POST /hosted/vrp/consent-requests Create VRP Consent
HostedPaymentPagesApi create_hosted_vrp_funds_confirmation POST /hosted/vrp/consent-requests/{consentRequestId}/funds-confirmation Check Funds Availability
HostedPaymentPagesApi create_hosted_vrp_payment POST /hosted/vrp/consent-requests/{consentRequestId}/payments Create VRP Payment
HostedPaymentPagesApi get_hosted_payment_request GET /hosted/payment-requests/{paymentRequestId} Get Hosted payment request
HostedPaymentPagesApi get_hosted_vrp_consent_request GET /hosted/vrp/consent-requests/{consentRequestId} Get Hosted VRP Consent Request
HostedPaymentPagesApi get_hosted_vrp_consent_requests GET /hosted/vrp/consent-requests Get Hosted VRP Consent Requests
HostedPaymentPagesApi get_hosted_vrp_payment_request GET /hosted/vrp/consent-requests/{consentRequestId}/payments/{paymentId} Get VRP payment
HostedPaymentPagesApi revoke_hosted_consent_request POST /hosted/vrp/consent-requests/{consentRequestId}/revoke Revoke Hosted VRP Consent Request
InstitutionsApi get_feature_details GET /features Get Features
InstitutionsApi get_institution GET /institutions/{institutionId} Get Institution
InstitutionsApi get_institutions GET /institutions Get Institutions
NotificationsApi create_event_subscription POST /notifications/event-subscriptions Create Event Subscription
NotificationsApi delete_event_subscription_by_id DELETE /notifications/event-subscriptions/{eventTypeId} Delete Event Subscription
NotificationsApi get_event_subscription_by_id GET /notifications/event-subscriptions/{eventTypeId} Get Event Subscription
NotificationsApi get_event_subscriptions GET /notifications/event-subscriptions Get Event Subscriptions
PaymentsApi create_bulk_payment POST /bulk-payments Create Bulk Payment
PaymentsApi create_payment POST /payments Create Payment
PaymentsApi get_bulk_payment_status GET /bulk-payments/{bulkPaymentId} Get Bulk Payment File Status
PaymentsApi get_payments GET /payments/{paymentId}/details Get Payment Details
UsersApi add_user POST /users Create User
UsersApi delete_user DELETE /users/{userUuid} Delete User
UsersApi get_user GET /users/{userUuid} Get User
UsersApi get_users GET /users Get Users
VariableRecurringPaymentsApi create_non_sweeping_authorisation POST /variable-recurring-payments/non-sweeping/consents Create Non-Sweeping Variable Recurring Payment Authorisation
VariableRecurringPaymentsApi create_sweeping_authorisation POST /variable-recurring-payments/sweeping/consents Create Sweeping Variable Recurring Payment Authorisation
VariableRecurringPaymentsApi create_vrp_funds_confirmation POST /variable-recurring-payments/funds-confirmation Confirm Funds for Variable Recurring Payment
VariableRecurringPaymentsApi create_vrp_payment POST /variable-recurring-payments/payments Create Variable Recurring Payment
VariableRecurringPaymentsApi get_non_sweeping_vrp_consent_by_id GET /variable-recurring-payments/non-sweeping/consents/{consentId} Get Non-Sweeping Variable Recurring Payment Consent Details
VariableRecurringPaymentsApi get_sweeping_vrp_consent_by_id GET /variable-recurring-payments/sweeping/consents/{consentId} Get Sweeping Variable Recurring Payment Consent Details
VariableRecurringPaymentsApi get_vrp_payment_details GET /variable-recurring-payments/payments/{paymentId}/details Get Variable Recurring Payment Details
WebhooksApi delete_webhook DELETE /webhook/events/{webhook_id} Delete Webhook Event
WebhooksApi get_registered_webhooks GET /webhook/events Retrieve All Webhook Events
WebhooksApi get_webhook_events_categories GET /webhook/events/categories Get Webhook Categories
WebhooksApi register_webhook POST /webhook/events Register Webhook Event
WebhooksApi webhook_secret_reset POST /webhook/secrets/{webhook_id} Reset Webhook Secret

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

basicAuth

  • Type: HTTP basic authentication

Author

[email protected]

About

No description, website, or topics provided.

Resources

Readme
Activity
Custom properties

Stars

0 stars

Watchers

2 watching

Forks

0 forks
Report repository

Releases 5

7.2.0 Latest
Jan 15, 2025
+ 4 releases

Packages

No packages published

Contributors 2

  •  
  •  

Languages