❤
npm
Sign UpSign In

@yapily/yapily-api

2.21.3 • Public • Published

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:

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.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.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.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 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.VirtualAccountsApi createVirtualAccount POST /virtual-accounts/accounts Create Account
YapilyApi.VirtualAccountsApi createVirtualAccountBeneficiary POST /virtual-accounts/beneficiaries Create Beneficiary
YapilyApi.VirtualAccountsApi createVirtualAccountClient POST /virtual-accounts/clients Create Virtual Account Client
YapilyApi.VirtualAccountsApi createVirtualAccountPayOut POST /virtual-accounts/payments/pay-outs Create Pay Out
YapilyApi.VirtualAccountsApi createVirtualAccountRefund POST /virtual-accounts/refunds Create Refund
YapilyApi.VirtualAccountsApi createVirtualAccountTransfer POST /virtual-accounts/payments/transfers Create Virtual Account Transfer
YapilyApi.VirtualAccountsApi deleteVirtualAccountBeneficiary DELETE /virtual-accounts/beneficiaries/{beneficiaryId} Delete Beneficiary
YapilyApi.VirtualAccountsApi getPayInDetails GET /virtual-accounts/payments/{paymentId}/pay-in-details Get Pay-In Details
YapilyApi.VirtualAccountsApi getPaymentsById GET /virtual-accounts/payments/{id} Get Payment
YapilyApi.VirtualAccountsApi getVirtualAccountBeneficiaries GET /virtual-accounts/beneficiaries Get List Of Beneficiaries
YapilyApi.VirtualAccountsApi getVirtualAccountBeneficiary GET /virtual-accounts/beneficiaries/{beneficiaryId} Get Beneficiary
YapilyApi.VirtualAccountsApi getVirtualAccountById GET /virtual-accounts/accounts/{accountId} Get Account
YapilyApi.VirtualAccountsApi getVirtualAccountClientById GET /virtual-accounts/clients/{clientId} Get a Virtual Account Client by ID
YapilyApi.VirtualAccountsApi getVirtualAccountClients GET /virtual-accounts/clients Get List of Virtual Account Clients
YapilyApi.VirtualAccountsApi getVirtualAccountPayments GET /virtual-accounts/payments Get Payments
YapilyApi.VirtualAccountsApi getVirtualAccountRefundById GET /virtual-accounts/refunds/{id} Get Refund By Id
YapilyApi.VirtualAccountsApi getVirtualAccountRefunds GET /virtual-accounts/refunds Get list of refunds
YapilyApi.VirtualAccountsApi getVirtualAccounts GET /virtual-accounts/accounts Get Accounts
YapilyApi.VirtualAccountsApi updateVirtualAccountById PATCH /virtual-accounts/accounts/{accountId} Update Account
YapilyApi.VirtualAccountsAccountsApi createVirtualAccount POST /virtual-accounts/accounts Create Account
YapilyApi.VirtualAccountsAccountsApi getVirtualAccountById GET /virtual-accounts/accounts/{accountId} Get Account
YapilyApi.VirtualAccountsAccountsApi getVirtualAccounts GET /virtual-accounts/accounts Get Accounts
YapilyApi.VirtualAccountsAccountsApi updateVirtualAccountById PATCH /virtual-accounts/accounts/{accountId} Update Account
YapilyApi.VirtualAccountsBeneficiariesApi createVirtualAccountBeneficiary POST /virtual-accounts/beneficiaries Create Beneficiary
YapilyApi.VirtualAccountsBeneficiariesApi deleteVirtualAccountBeneficiary DELETE /virtual-accounts/beneficiaries/{beneficiaryId} Delete Beneficiary
YapilyApi.VirtualAccountsBeneficiariesApi getVirtualAccountBeneficiaries GET /virtual-accounts/beneficiaries Get List Of Beneficiaries
YapilyApi.VirtualAccountsBeneficiariesApi getVirtualAccountBeneficiary GET /virtual-accounts/beneficiaries/{beneficiaryId} Get Beneficiary
YapilyApi.VirtualAccountsClientsApi createVirtualAccountClient POST /virtual-accounts/clients Create Virtual Account Client
YapilyApi.VirtualAccountsClientsApi getVirtualAccountClientById GET /virtual-accounts/clients/{clientId} Get a Virtual Account Client by ID
YapilyApi.VirtualAccountsClientsApi getVirtualAccountClients GET /virtual-accounts/clients Get List of Virtual Account Clients
YapilyApi.VirtualAccountsPaymentsApi createVirtualAccountPayOut POST /virtual-accounts/payments/pay-outs Create Pay Out
YapilyApi.VirtualAccountsPaymentsApi createVirtualAccountTransfer POST /virtual-accounts/payments/transfers Create Virtual Account Transfer
YapilyApi.VirtualAccountsPaymentsApi getPayInDetails GET /virtual-accounts/payments/{paymentId}/pay-in-details Get Pay-In Details
YapilyApi.VirtualAccountsPaymentsApi getPaymentsById GET /virtual-accounts/payments/{id} Get Payment
YapilyApi.VirtualAccountsPaymentsApi getVirtualAccountPayments GET /virtual-accounts/payments Get Payments
YapilyApi.VirtualAccountsRefundsApi createVirtualAccountRefund POST /virtual-accounts/refunds Create Refund
YapilyApi.VirtualAccountsRefundsApi getVirtualAccountRefundById GET /virtual-accounts/refunds/{id} Get Refund By Id
YapilyApi.VirtualAccountsRefundsApi getVirtualAccountRefunds GET /virtual-accounts/refunds Get list of refunds

Documentation for Models

Documentation for Authorization

basicAuth

  • Type: HTTP basic authentication

Readme

Keywords

Package Sidebar

Install

npm i @yapily/yapily-api

Repository

github.com/yapily/yapily-sdk-nodejs

Homepage

github.com/yapily/yapily-sdk-nodejs#readme

Weekly Downloads

276

Version

2.21.3

License

Unlicense

Unpacked Size

44.2 kB

Total Files

3

Last publish

Collaborators

  • sammacharia
  • foksot
  • suki.rama
  • samwillis
  • rafael_yapily
  • pablo.yapily
Try on RunKit
Report malware