@yapily/yapily-api

v8.0.0

Published

8 months ago

The_Yapily_API_enables_connections_between_your_application_and_users_banks__For_more_information_check_out_our__documentation_https__docs_yapily_com__brbrIn_particular_make_sure_to_view_our__Getting_Started_https__docs_yapily_com_pages_home_getting_start

Downloads

668

0High
0Medium
0Low

suki.rama

api sdk yapily yapily-api yapily-sdk

yapily-api

YapilyApi - JavaScript client for yapily-api 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 SDK is automatically generated by the OpenAPI Generator project:

API version: 8.0.0
Package version: 8.0.0
Build package: org.openapitools.codegen.languages.JavascriptClientCodegen For more information, please visit https://docs.yapily.com/pages/resources/support/

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install @yapily/yapily-api --save

Finally, you need to build the module:

npm run build

Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

To use the link you just defined in your project, switch to the directory you want to use your yapily-api from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

Finally, you need to build the module:

npm run build

git

If the library is hosted at a git repository, e.g.https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var YapilyApi = require('@yapily/yapily-api');

var defaultClient = YapilyApi.ApiClient.instance;
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new YapilyApi.ApplicationApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getApplicationMe(callback);

Documentation for API Endpoints

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

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- YapilyApi.ApplicationApi | getApplicationMe | GET /me | Get Application Self YapilyApi.ApplicationManagementApi | createApplicationVRPConfigurationByApplicationId | POST /applications/{applicationId}/vrp | Create application VRP configuration by Application Id YapilyApi.ApplicationManagementApi | createSubApplication | POST /applications | Creates a sub-application for the root application id provided in the authentication token YapilyApi.ApplicationManagementApi | deleteApplication | DELETE /applications/{applicationId} | Delete an application YapilyApi.ApplicationManagementApi | getApplicationById | GET /applications/{applicationId} | Get application details YapilyApi.ApplicationManagementApi | getApplicationVRPConfigurationByApplicationId | GET /applications/{applicationId}/vrp | Get application VRP configuration by Application Id YapilyApi.ApplicationManagementApi | searchApplications | GET /applications | Retrieve sub-applications for the root application provided in the authentication token. YapilyApi.ApplicationManagementApi | updateApplication | PUT /applications/{applicationId} | Update an Application YapilyApi.ApplicationManagementApi | updateApplicationVRPConfigurationByApplicationId | PUT /applications/{applicationId}/vrp | Update application VRP configuration by Application Id YapilyApi.AuthorisationsApi | createBulkPaymentAuthorisation | POST /bulk-payment-auth-requests | Create Bulk Payment Authorisation YapilyApi.AuthorisationsApi | createEmbeddedBulkPaymentAuthorisation | POST /embedded-bulk-payment-auth-requests | Create Embedded Bulk Payment Authorisation YapilyApi.AuthorisationsApi | createEmbeddedPaymentAuthorisation | POST /embedded-payment-auth-requests | Create Embedded Payment Authorisation YapilyApi.AuthorisationsApi | createPaymentAuthorisation | POST /payment-auth-requests | Create Payment Authorisation YapilyApi.AuthorisationsApi | createPaymentPreAuthorisationRequest | POST /payment-pre-auth-requests | Create Payment Pre-authorisation YapilyApi.AuthorisationsApi | createPreAuthorisationRequest | POST /pre-auth-requests | Create Pre-authorisation YapilyApi.AuthorisationsApi | initiateAccountRequest | POST /account-auth-requests | Create Account Authorisation YapilyApi.AuthorisationsApi | initiateEmbeddedAccountRequest | POST /embedded-account-auth-requests | Create Embedded Account Authorisation YapilyApi.AuthorisationsApi | reAuthoriseAccount | PATCH /account-auth-requests | Re-authorise Account Consent YapilyApi.AuthorisationsApi | updateEmbeddedAccountRequest | PUT /embedded-account-auth-requests/{consentId} | Update Embedded Account Authorisation YapilyApi.AuthorisationsApi | updateEmbeddedBulkPaymentAuthorisation | PUT /embedded-bulk-payment-auth-requests/{consentId} | Update Embedded Bulk Payment Authorisation YapilyApi.AuthorisationsApi | updateEmbeddedPaymentAuthorisation | PUT /embedded-payment-auth-requests/{consentId} | Update Embedded Payment Authorisation YapilyApi.AuthorisationsApi | updatePaymentAuthorisation | PUT /payment-auth-requests | Update Payment Pre-authorisation YapilyApi.AuthorisationsApi | updatePreAuthoriseAccountConsent | PUT /account-auth-requests | Update Account Pre-authorisation YapilyApi.ConsentsApi | callDelete | DELETE /consents/{consentId} | Delete Consent YapilyApi.ConsentsApi | createConsentWithCode | POST /consent-auth-code | Exchange OAuth2 Code YapilyApi.ConsentsApi | extendConsent | POST /consents/{consentId}/extend | Extend Consent YapilyApi.ConsentsApi | getConsentById | GET /consents/{consentId} | Get Consent YapilyApi.ConsentsApi | getConsentBySingleAccessConsent | POST /consent-one-time-token | Exchange One Time Token YapilyApi.ConsentsApi | getConsents | GET /consents | Get Consents YapilyApi.ConstraintsApi | getAccountConstraintsRulesByInstitution | GET /institutions/constraints/data | Get Data Constraints Rules YapilyApi.ConstraintsApi | getPaymentConstraintsRulesByInstitution | GET /institutions/constraints/payments | Get Payment Constraints Rules YapilyApi.EnrichmentApi | getAccountsTransactionsCategorised | GET /accounts/{accountId}/transactions/categorisation/{categorisationId} | Get Categorised Transactions YapilyApi.EnrichmentApi | getCategorisationAccountType | GET /transactions/categorisation/categories/{accountType} | Get the list of all categories for a specific account type YapilyApi.EnrichmentApi | postAccountsAccountIdTransactionsCategorisation | POST /accounts/{accountId}/transactions/categorisation | Trigger transaction categorisation YapilyApi.FinancialDataApi | getAccount | GET /accounts/{accountId} | Get Account YapilyApi.FinancialDataApi | getAccountBalances | GET /accounts/{accountId}/balances | Get Account Balances YapilyApi.FinancialDataApi | getAccountDirectDebits | GET /accounts/{accountId}/direct-debits | Get Account Direct Debits YapilyApi.FinancialDataApi | getAccountPeriodicPayments | GET /accounts/{accountId}/periodic-payments | Get Account Periodic Payments YapilyApi.FinancialDataApi | getAccountScheduledPayments | GET /accounts/{accountId}/scheduled-payments | Get Account Scheduled Payments YapilyApi.FinancialDataApi | getAccounts | GET /accounts | Get Accounts YapilyApi.FinancialDataApi | getBeneficiaries | GET /accounts/{accountId}/beneficiaries | Get Account Beneficiaries YapilyApi.FinancialDataApi | getCategories | GET /categories/{country} | Get Categories YapilyApi.FinancialDataApi | getIdentity | GET /identity | Get Identity YapilyApi.FinancialDataApi | getRealTimeTransactions | GET /accounts/{accountId}/real-time/transactions | Get Real Time Account Transactions YapilyApi.FinancialDataApi | getStatement | GET /accounts/{accountId}/statements/{statementId} | Get Account Statement YapilyApi.FinancialDataApi | getStatementFile | GET /accounts/{accountId}/statements/{statementId}/file | Get Account Statement File YapilyApi.FinancialDataApi | getStatements | GET /accounts/{accountId}/statements | Get Account Statements YapilyApi.FinancialDataApi | getTransactions | GET /accounts/{accountId}/transactions | Get Account Transactions YapilyApi.FinancialProfileApi | createProfileConsent | POST /users/{userUuid}/profile/consents | Create Profile Consent YapilyApi.FinancialProfileApi | deleteProfileConsent | DELETE /users/{userUuid}/profile/consents/{profileConsentId} | Delete Profile Consent YapilyApi.FinancialProfileApi | getBalancePrediction | GET /users/{userUuid}/profile/predicted-balances | Get Predicted Balances YapilyApi.FinancialProfileApi | getProfileConsent | GET /users/{userUuid}/profile/consents/{profileConsentId} | Get Profile Consent YapilyApi.FinancialProfileApi | getUserProfile | GET /users/{userUuid}/profile/transaction-groups | Get Transaction Groups YapilyApi.HostedConsentPagesApi | createHostedConsentRequest | POST /hosted/consent-requests | Create Hosted Consent Request YapilyApi.HostedConsentPagesApi | getHostedConsentRequest | GET /hosted/consent-requests/{consentRequestId} | Get Hosted Consent Request YapilyApi.HostedPaymentPagesApi | createHostedPaymentRequest | POST /hosted/payment-requests | Create Hosted payment request YapilyApi.HostedPaymentPagesApi | createHostedPaymentRequestLink | POST /hosted/payment-requests/links | Create Pay By Link YapilyApi.HostedPaymentPagesApi | createHostedVRPConsentRequest | POST /hosted/vrp/consent-requests | Create VRP Consent YapilyApi.HostedPaymentPagesApi | createHostedVrpFundsConfirmation | POST /hosted/vrp/consent-requests/{consentRequestId}/funds-confirmation | Check Funds Availability YapilyApi.HostedPaymentPagesApi | createHostedVrpPayment | POST /hosted/vrp/consent-requests/{consentRequestId}/payments | Create VRP Payment YapilyApi.HostedPaymentPagesApi | getHostedPaymentRequest | GET /hosted/payment-requests/{paymentRequestId} | Get Hosted payment request YapilyApi.HostedPaymentPagesApi | getHostedVRPConsentRequests | GET /hosted/vrp/consent-requests | Get Hosted VRP Consent Requests YapilyApi.HostedPaymentPagesApi | getHostedVRPPaymentRequest | GET /hosted/vrp/consent-requests/{consentRequestId}/payments/{paymentId} | Get VRP payment YapilyApi.HostedPaymentPagesApi | getHostedVrpConsentRequest | GET /hosted/vrp/consent-requests/{consentRequestId} | Get Hosted VRP Consent Request YapilyApi.HostedPaymentPagesApi | revokeHostedConsentRequest | POST /hosted/vrp/consent-requests/{consentRequestId}/revoke | Revoke Hosted VRP Consent Request YapilyApi.InstitutionsApi | getFeatureDetails | GET /features | Get Features YapilyApi.InstitutionsApi | getInstitution | GET /institutions/{institutionId} | Get Institution YapilyApi.InstitutionsApi | getInstitutions | GET /institutions | Get Institutions YapilyApi.NotificationsApi | createEventSubscription | POST /notifications/event-subscriptions | Create Event Subscription YapilyApi.NotificationsApi | deleteEventSubscriptionById | DELETE /notifications/event-subscriptions/{eventTypeId} | Delete Event Subscription YapilyApi.NotificationsApi | getEventSubscriptionById | GET /notifications/event-subscriptions/{eventTypeId} | Get Event Subscription YapilyApi.NotificationsApi | getEventSubscriptions | GET /notifications/event-subscriptions | Get Event Subscriptions YapilyApi.PaymentsApi | createBulkPayment | POST /bulk-payments | Create Bulk Payment YapilyApi.PaymentsApi | createPayment | POST /payments | Create Payment YapilyApi.PaymentsApi | getBulkPaymentStatus | GET /bulk-payments/{bulkPaymentId} | Get Bulk Payment File Status YapilyApi.PaymentsApi | getPayments | GET /payments/{paymentId}/details | Get Payment Details YapilyApi.UsersApi | addUser | POST /users | Create User YapilyApi.UsersApi | deleteUser | DELETE /users/{userUuid} | Delete User YapilyApi.UsersApi | getUser | GET /users/{userUuid} | Get User YapilyApi.UsersApi | getUsers | GET /users | Get Users YapilyApi.VariableRecurringPaymentsApi | createNonSweepingAuthorisation | POST /variable-recurring-payments/non-sweeping/consents | Create Non-Sweeping Variable Recurring Payment Authorisation YapilyApi.VariableRecurringPaymentsApi | createSweepingAuthorisation | POST /variable-recurring-payments/sweeping/consents | Create Sweeping Variable Recurring Payment Authorisation YapilyApi.VariableRecurringPaymentsApi | createVrpFundsConfirmation | POST /variable-recurring-payments/funds-confirmation | Confirm Funds for Variable Recurring Payment YapilyApi.VariableRecurringPaymentsApi | createVrpPayment | POST /variable-recurring-payments/payments | Create Variable Recurring Payment YapilyApi.VariableRecurringPaymentsApi | getNonSweepingVrpConsentById | GET /variable-recurring-payments/non-sweeping/consents/{consentId} | Get Non-Sweeping Variable Recurring Payment Consent Details YapilyApi.VariableRecurringPaymentsApi | getSweepingVrpConsentById | GET /variable-recurring-payments/sweeping/consents/{consentId} | Get Sweeping Variable Recurring Payment Consent Details YapilyApi.VariableRecurringPaymentsApi | getVrpPaymentDetails | GET /variable-recurring-payments/payments/{paymentId}/details | Get Variable Recurring Payment Details YapilyApi.WebhooksApi | deleteWebhook | DELETE /webhook/events/{webhook_id} | Delete Webhook Event YapilyApi.WebhooksApi | getRegisteredWebhooks | GET /webhook/events | Retrieve All Webhook Events YapilyApi.WebhooksApi | getWebhookEventsCategories | GET /webhook/events/categories | Get Webhook Categories YapilyApi.WebhooksApi | registerWebhook | POST /webhook/events | Register Webhook Event YapilyApi.WebhooksApi | webhookSecretReset | POST /webhook/secrets/{webhook_id} | Reset Webhook Secret

Documentation for Models

Documentation for Authorization

basicAuth

Type: HTTP basic authentication