2.21.3 • Published 2 years ago

@yapily/yapily-api v2.21.3

Weekly downloads
733
License
Unlicense
Repository
github
Last release
2 years ago

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

ClassMethodHTTP requestDescription
YapilyApi.ApplicationApigetApplicationMeGET /meGet Application Self
YapilyApi.AuthorisationsApicreateBulkPaymentAuthorisationPOST /bulk-payment-auth-requestsCreate Bulk Payment Authorisation
YapilyApi.AuthorisationsApicreateEmbeddedBulkPaymentAuthorisationPOST /embedded-bulk-payment-auth-requestsCreate Embedded Bulk Payment Authorisation
YapilyApi.AuthorisationsApicreateEmbeddedPaymentAuthorisationPOST /embedded-payment-auth-requestsCreate Embedded Payment Authorisation
YapilyApi.AuthorisationsApicreatePaymentAuthorisationPOST /payment-auth-requestsCreate Payment Authorisation
YapilyApi.AuthorisationsApicreatePaymentPreAuthorisationRequestPOST /payment-pre-auth-requestsCreate Payment Pre-authorisation
YapilyApi.AuthorisationsApicreatePreAuthorisationRequestPOST /pre-auth-requestsCreate Pre-authorisation
YapilyApi.AuthorisationsApiinitiateAccountRequestPOST /account-auth-requestsCreate Account Authorisation
YapilyApi.AuthorisationsApiinitiateEmbeddedAccountRequestPOST /embedded-account-auth-requestsCreate Embedded Account Authorisation
YapilyApi.AuthorisationsApireAuthoriseAccountPATCH /account-auth-requestsRe-authorise Account Consent
YapilyApi.AuthorisationsApiupdateEmbeddedAccountRequestPUT /embedded-account-auth-requests/{consentId}Update Embedded Account Authorisation
YapilyApi.AuthorisationsApiupdateEmbeddedBulkPaymentAuthorisationPUT /embedded-bulk-payment-auth-requests/{consentId}Update Embedded Bulk Payment Authorisation
YapilyApi.AuthorisationsApiupdateEmbeddedPaymentAuthorisationPUT /embedded-payment-auth-requests/{consentId}Update Embedded Payment Authorisation
YapilyApi.AuthorisationsApiupdatePaymentAuthorisationPUT /payment-auth-requestsUpdate Payment Pre-authorisation
YapilyApi.AuthorisationsApiupdatePreAuthoriseAccountConsentPUT /account-auth-requestsUpdate Account Pre-authorisation
YapilyApi.ConsentsApicallDeleteDELETE /consents/{consentId}Delete Consent
YapilyApi.ConsentsApicreateConsentWithCodePOST /consent-auth-codeExchange OAuth2 Code
YapilyApi.ConsentsApiextendConsentPOST /consents/{consentId}/extendExtend Consent
YapilyApi.ConsentsApigetConsentByIdGET /consents/{consentId}Get Consent
YapilyApi.ConsentsApigetConsentBySingleAccessConsentPOST /consent-one-time-tokenExchange One Time Token
YapilyApi.ConsentsApigetConsentsGET /consentsGet Consents
YapilyApi.FinancialDataApigetAccountGET /accounts/{accountId}Get Account
YapilyApi.FinancialDataApigetAccountBalancesGET /accounts/{accountId}/balancesGet Account Balances
YapilyApi.FinancialDataApigetAccountDirectDebitsGET /accounts/{accountId}/direct-debitsGet Account Direct Debits
YapilyApi.FinancialDataApigetAccountPeriodicPaymentsGET /accounts/{accountId}/periodic-paymentsGet Account Periodic Payments
YapilyApi.FinancialDataApigetAccountScheduledPaymentsGET /accounts/{accountId}/scheduled-paymentsGet Account Scheduled Payments
YapilyApi.FinancialDataApigetAccountsGET /accountsGet Accounts
YapilyApi.FinancialDataApigetBeneficiariesGET /accounts/{accountId}/beneficiariesGet Account Beneficiaries
YapilyApi.FinancialDataApigetCategoriesGET /categories/{country}Get Categories
YapilyApi.FinancialDataApigetIdentityGET /identityGet Identity
YapilyApi.FinancialDataApigetRealTimeTransactionsGET /accounts/{accountId}/real-time/transactionsGet Real Time Account Transactions
YapilyApi.FinancialDataApigetStatementGET /accounts/{accountId}/statements/{statementId}Get Account Statement
YapilyApi.FinancialDataApigetStatementFileGET /accounts/{accountId}/statements/{statementId}/fileGet Account Statement File
YapilyApi.FinancialDataApigetStatementsGET /accounts/{accountId}/statementsGet Account Statements
YapilyApi.FinancialDataApigetTransactionsGET /accounts/{accountId}/transactionsGet Account Transactions
YapilyApi.FinancialProfileApicreateProfileConsentPOST /users/{userUuid}/profile/consentsCreate Profile Consent
YapilyApi.FinancialProfileApideleteProfileConsentDELETE /users/{userUuid}/profile/consents/{profileConsentId}Delete Profile Consent
YapilyApi.FinancialProfileApigetBalancePredictionGET /users/{userUuid}/profile/predicted-balancesGet Predicted Balances
YapilyApi.FinancialProfileApigetProfileConsentGET /users/{userUuid}/profile/consents/{profileConsentId}Get Profile Consent
YapilyApi.FinancialProfileApigetUserProfileGET /users/{userUuid}/profile/transaction-groupsGet Transaction Groups
YapilyApi.InstitutionsApigetFeatureDetailsGET /featuresGet Features
YapilyApi.InstitutionsApigetInstitutionGET /institutions/{institutionId}Get Institution
YapilyApi.InstitutionsApigetInstitutionsGET /institutionsGet Institutions
YapilyApi.NotificationsApicreateEventSubscriptionPOST /notifications/event-subscriptionsCreate Event Subscription
YapilyApi.NotificationsApideleteEventSubscriptionByIdDELETE /notifications/event-subscriptions/{eventTypeId}Delete Event Subscription
YapilyApi.NotificationsApigetEventSubscriptionByIdGET /notifications/event-subscriptions/{eventTypeId}Get Event Subscription
YapilyApi.NotificationsApigetEventSubscriptionsGET /notifications/event-subscriptionsGet Event Subscriptions
YapilyApi.PaymentsApicreateBulkPaymentPOST /bulk-paymentsCreate Bulk Payment
YapilyApi.PaymentsApicreatePaymentPOST /paymentsCreate Payment
YapilyApi.PaymentsApigetPaymentsGET /payments/{paymentId}/detailsGet Payment Details
YapilyApi.UsersApiaddUserPOST /usersCreate User
YapilyApi.UsersApideleteUserDELETE /users/{userUuid}Delete User
YapilyApi.UsersApigetUserGET /users/{userUuid}Get User
YapilyApi.UsersApigetUsersGET /usersGet Users
YapilyApi.VariableRecurringPaymentsApicreateNonSweepingAuthorisationPOST /variable-recurring-payments/non-sweeping/consentsCreate Non-Sweeping Variable Recurring Payment Authorisation
YapilyApi.VariableRecurringPaymentsApicreateSweepingAuthorisationPOST /variable-recurring-payments/sweeping/consentsCreate Sweeping Variable Recurring Payment Authorisation
YapilyApi.VariableRecurringPaymentsApicreateVrpFundsConfirmationPOST /variable-recurring-payments/funds-confirmationConfirm Funds for Variable Recurring Payment
YapilyApi.VariableRecurringPaymentsApicreateVrpPaymentPOST /variable-recurring-payments/paymentsCreate Variable Recurring Payment
YapilyApi.VariableRecurringPaymentsApigetNonSweepingVrpConsentByIdGET /variable-recurring-payments/non-sweeping/consents/{consentId}Get Non-Sweeping Variable Recurring Payment Consent Details
YapilyApi.VariableRecurringPaymentsApigetSweepingVrpConsentByIdGET /variable-recurring-payments/sweeping/consents/{consentId}Get Sweeping Variable Recurring Payment Consent Details
YapilyApi.VariableRecurringPaymentsApigetVrpPaymentDetailsGET /variable-recurring-payments/payments/{paymentId}/detailsGet Variable Recurring Payment Details
YapilyApi.VirtualAccountsApicreateVirtualAccountPOST /virtual-accounts/accountsCreate Account
YapilyApi.VirtualAccountsApicreateVirtualAccountBeneficiaryPOST /virtual-accounts/beneficiariesCreate Beneficiary
YapilyApi.VirtualAccountsApicreateVirtualAccountClientPOST /virtual-accounts/clientsCreate Virtual Account Client
YapilyApi.VirtualAccountsApicreateVirtualAccountPayOutPOST /virtual-accounts/payments/pay-outsCreate Pay Out
YapilyApi.VirtualAccountsApicreateVirtualAccountRefundPOST /virtual-accounts/refundsCreate Refund
YapilyApi.VirtualAccountsApicreateVirtualAccountTransferPOST /virtual-accounts/payments/transfersCreate Virtual Account Transfer
YapilyApi.VirtualAccountsApideleteVirtualAccountBeneficiaryDELETE /virtual-accounts/beneficiaries/{beneficiaryId}Delete Beneficiary
YapilyApi.VirtualAccountsApigetPayInDetailsGET /virtual-accounts/payments/{paymentId}/pay-in-detailsGet Pay-In Details
YapilyApi.VirtualAccountsApigetPaymentsByIdGET /virtual-accounts/payments/{id}Get Payment
YapilyApi.VirtualAccountsApigetVirtualAccountBeneficiariesGET /virtual-accounts/beneficiariesGet List Of Beneficiaries
YapilyApi.VirtualAccountsApigetVirtualAccountBeneficiaryGET /virtual-accounts/beneficiaries/{beneficiaryId}Get Beneficiary
YapilyApi.VirtualAccountsApigetVirtualAccountByIdGET /virtual-accounts/accounts/{accountId}Get Account
YapilyApi.VirtualAccountsApigetVirtualAccountClientByIdGET /virtual-accounts/clients/{clientId}Get a Virtual Account Client by ID
YapilyApi.VirtualAccountsApigetVirtualAccountClientsGET /virtual-accounts/clientsGet List of Virtual Account Clients
YapilyApi.VirtualAccountsApigetVirtualAccountPaymentsGET /virtual-accounts/paymentsGet Payments
YapilyApi.VirtualAccountsApigetVirtualAccountRefundByIdGET /virtual-accounts/refunds/{id}Get Refund By Id
YapilyApi.VirtualAccountsApigetVirtualAccountRefundsGET /virtual-accounts/refundsGet list of refunds
YapilyApi.VirtualAccountsApigetVirtualAccountsGET /virtual-accounts/accountsGet Accounts
YapilyApi.VirtualAccountsApiupdateVirtualAccountByIdPATCH /virtual-accounts/accounts/{accountId}Update Account
YapilyApi.VirtualAccountsAccountsApicreateVirtualAccountPOST /virtual-accounts/accountsCreate Account
YapilyApi.VirtualAccountsAccountsApigetVirtualAccountByIdGET /virtual-accounts/accounts/{accountId}Get Account
YapilyApi.VirtualAccountsAccountsApigetVirtualAccountsGET /virtual-accounts/accountsGet Accounts
YapilyApi.VirtualAccountsAccountsApiupdateVirtualAccountByIdPATCH /virtual-accounts/accounts/{accountId}Update Account
YapilyApi.VirtualAccountsBeneficiariesApicreateVirtualAccountBeneficiaryPOST /virtual-accounts/beneficiariesCreate Beneficiary
YapilyApi.VirtualAccountsBeneficiariesApideleteVirtualAccountBeneficiaryDELETE /virtual-accounts/beneficiaries/{beneficiaryId}Delete Beneficiary
YapilyApi.VirtualAccountsBeneficiariesApigetVirtualAccountBeneficiariesGET /virtual-accounts/beneficiariesGet List Of Beneficiaries
YapilyApi.VirtualAccountsBeneficiariesApigetVirtualAccountBeneficiaryGET /virtual-accounts/beneficiaries/{beneficiaryId}Get Beneficiary
YapilyApi.VirtualAccountsClientsApicreateVirtualAccountClientPOST /virtual-accounts/clientsCreate Virtual Account Client
YapilyApi.VirtualAccountsClientsApigetVirtualAccountClientByIdGET /virtual-accounts/clients/{clientId}Get a Virtual Account Client by ID
YapilyApi.VirtualAccountsClientsApigetVirtualAccountClientsGET /virtual-accounts/clientsGet List of Virtual Account Clients
YapilyApi.VirtualAccountsPaymentsApicreateVirtualAccountPayOutPOST /virtual-accounts/payments/pay-outsCreate Pay Out
YapilyApi.VirtualAccountsPaymentsApicreateVirtualAccountTransferPOST /virtual-accounts/payments/transfersCreate Virtual Account Transfer
YapilyApi.VirtualAccountsPaymentsApigetPayInDetailsGET /virtual-accounts/payments/{paymentId}/pay-in-detailsGet Pay-In Details
YapilyApi.VirtualAccountsPaymentsApigetPaymentsByIdGET /virtual-accounts/payments/{id}Get Payment
YapilyApi.VirtualAccountsPaymentsApigetVirtualAccountPaymentsGET /virtual-accounts/paymentsGet Payments
YapilyApi.VirtualAccountsRefundsApicreateVirtualAccountRefundPOST /virtual-accounts/refundsCreate Refund
YapilyApi.VirtualAccountsRefundsApigetVirtualAccountRefundByIdGET /virtual-accounts/refunds/{id}Get Refund By Id
YapilyApi.VirtualAccountsRefundsApigetVirtualAccountRefundsGET /virtual-accounts/refundsGet list of refunds

Documentation for Models

Documentation for Authorization

basicAuth

  • Type: HTTP basic authentication
apisdkyapilyyapily-apiyapily-sdk
@babel/clisuperagent
@infinitebrahmanuniverse/nolb-_yap@everything-registry/sub-chunk-1038@zalastax/nolb-_yap
2.21.3

2 years ago

2.20.0

2 years ago

2.19.1

2 years ago

2.18.0

2 years ago

2.16.0

3 years ago

2.15.0

3 years ago

2.13.1

3 years ago

1.213.0

4 years ago

1.251.1

3 years ago

1.251.2

3 years ago

1.251.0

3 years ago

1.259.0

3 years ago

1.187.0

4 years ago

1.176.0

4 years ago

1.163.0

4 years ago

1.186.0

4 years ago

1.208.0

4 years ago

1.198.1

4 years ago

1.198.0

4 years ago

1.198.3

4 years ago

1.181.0

4 years ago

1.189.0

4 years ago

1.249.0

3 years ago

1.193.2

4 years ago

1.193.0

4 years ago

1.214.0

4 years ago

1.225.0

4 years ago

1.154.0

4 years ago

1.232.1

4 years ago

1.232.2

4 years ago

1.168.0

4 years ago

1.220.0

4 years ago

1.205.0

4 years ago

1.157.0

4 years ago

1.167.0

4 years ago

1.179.0

4 years ago

1.219.0

4 years ago

1.211.0

4 years ago

1.147.0

4 years ago

1.207.0

4 years ago

1.174.0

4 years ago

1.159.0

4 years ago

1.169.0

4 years ago

1.221.0

4 years ago

1.229.0

4 years ago

1.158.0

4 years ago

1.142.0

4 years ago

1.138.0

4 years ago

1.120.0

4 years ago

1.127.0

4 years ago

1.124.0

4 years ago

1.123.0

4 years ago

1.135.0

4 years ago

1.90.0

4 years ago

1.87.0

4 years ago

1.82.0

4 years ago

1.69.0

4 years ago

1.73.0

4 years ago

1.81.0

4 years ago

1.64.0

4 years ago

1.44.0

4 years ago

1.51.0

4 years ago

0.0.401

4 years ago

0.0.398

4 years ago

0.0.394

4 years ago

0.0.396

4 years ago

0.0.391

4 years ago

0.0.378

4 years ago

0.0.383

4 years ago

0.0.373

4 years ago

0.0.371

4 years ago

0.0.366

4 years ago

0.0.365

4 years ago

0.0.364

4 years ago

0.0.362

4 years ago

0.0.363

4 years ago

0.0.361

4 years ago

0.0.360

4 years ago

0.0.359

4 years ago

0.0.358

4 years ago

0.0.357

4 years ago

0.0.356

4 years ago

0.0.355

4 years ago

0.0.354

4 years ago

0.0.349

4 years ago

0.0.351

4 years ago

0.0.350

4 years ago

0.0.353

4 years ago

0.0.352

4 years ago

0.0.337

4 years ago

0.0.336

4 years ago

0.0.335

4 years ago

0.0.334

4 years ago

0.0.339

4 years ago

0.0.338

4 years ago

0.0.348

4 years ago

0.0.347

4 years ago

0.0.346

4 years ago

0.0.345

4 years ago

0.0.344

4 years ago

0.0.343

4 years ago

0.0.333

4 years ago

0.0.332

4 years ago

0.0.331

4 years ago

0.0.330

4 years ago

0.0.329

4 years ago

0.0.328

4 years ago

0.0.327

4 years ago

0.0.326

4 years ago

0.0.325

4 years ago

0.0.324

4 years ago

0.0.323

4 years ago

0.0.322

4 years ago

0.0.321

4 years ago

0.0.319

4 years ago

0.0.320

4 years ago

0.0.318

4 years ago

0.0.317

4 years ago

0.0.315

4 years ago

0.0.314

4 years ago

0.0.316

4 years ago

0.0.313

4 years ago

0.0.312

4 years ago

0.0.311

4 years ago

0.0.310

4 years ago

0.0.309

4 years ago

0.0.308

4 years ago

0.0.307

4 years ago

0.0.306

4 years ago

0.0.305

4 years ago

0.0.304

4 years ago

0.0.303

4 years ago

0.0.302

4 years ago

0.0.301

4 years ago

0.0.300

5 years ago

0.0.299

5 years ago

0.0.298

5 years ago

0.0.297

5 years ago

0.0.296

5 years ago

0.0.295

5 years ago

0.0.294

5 years ago

0.0.293

5 years ago

0.0.292

5 years ago

0.0.291

5 years ago

0.0.290

5 years ago

0.0.289

5 years ago

0.0.288

5 years ago

0.0.287

5 years ago

0.0.286

5 years ago

0.0.285

5 years ago

0.0.284

5 years ago

0.0.283

5 years ago

0.0.282

5 years ago

0.0.281

5 years ago

0.0.280

5 years ago

0.0.279

5 years ago

0.0.278

5 years ago

0.0.277

5 years ago

0.0.276

5 years ago

0.0.275

5 years ago

0.0.274

5 years ago

0.0.273

5 years ago

0.0.272

5 years ago

0.0.271

5 years ago

0.0.269

5 years ago

0.0.268

5 years ago

0.0.267

5 years ago

0.0.266

5 years ago

0.0.265

5 years ago

0.0.264

5 years ago

0.0.263

5 years ago

0.0.262

5 years ago

0.0.261

5 years ago

0.0.260

5 years ago

0.0.259

5 years ago

0.0.258

5 years ago

0.0.257

5 years ago

0.0.256

5 years ago

0.0.255

5 years ago

0.0.254

5 years ago

0.0.253

5 years ago

0.0.252

5 years ago

0.0.251

5 years ago

0.0.250

5 years ago

0.0.249

5 years ago

0.0.248

5 years ago

0.0.247

5 years ago

0.0.246

5 years ago

0.0.245

5 years ago

0.0.244

5 years ago

0.0.243

5 years ago

0.0.242

5 years ago

0.0.241

5 years ago

0.0.240

5 years ago

0.0.239

5 years ago

0.0.238

5 years ago

0.0.237

5 years ago

0.0.236

5 years ago

0.0.235

5 years ago

0.0.234

5 years ago

0.0.233

5 years ago

0.0.232

5 years ago

0.0.231

5 years ago

0.0.230

5 years ago

0.0.229

5 years ago

0.0.228

5 years ago

0.0.227

5 years ago

0.0.226

5 years ago

0.0.225

5 years ago

0.0.224

5 years ago

0.0.223

5 years ago

0.0.222

5 years ago

0.0.221

5 years ago

0.0.220

5 years ago

0.0.219

5 years ago

0.0.218

5 years ago

0.0.217

5 years ago

0.0.216

5 years ago

0.0.215

5 years ago

0.0.214

5 years ago

0.0.213

5 years ago

0.0.212

5 years ago

0.0.211

5 years ago

0.0.210

5 years ago

0.0.209

5 years ago

0.0.208

5 years ago

0.0.207

5 years ago

0.0.205

5 years ago

0.0.206

5 years ago

0.0.204

5 years ago

0.0.203

5 years ago

0.0.202

5 years ago

0.0.201

5 years ago

0.0.200

5 years ago

0.0.199

5 years ago

0.0.198

5 years ago

0.0.197

5 years ago

0.0.196

5 years ago

0.0.195

5 years ago

0.0.194

5 years ago

0.0.193

5 years ago

0.0.192

5 years ago

0.0.191

5 years ago

0.0.190

5 years ago

0.0.189

5 years ago

0.0.188

5 years ago

0.0.187

5 years ago

0.0.186

5 years ago

0.0.185

5 years ago

0.0.184

5 years ago

0.0.183

5 years ago

0.0.182

5 years ago

0.0.181

5 years ago

0.0.180

5 years ago

0.0.179

5 years ago

0.0.178

5 years ago

0.0.177

5 years ago

0.0.176

5 years ago

0.0.175

5 years ago

0.0.174

5 years ago

0.0.169

5 years ago

0.0.173

5 years ago

0.0.172

5 years ago

0.0.168

5 years ago

0.0.167

5 years ago

0.0.171

5 years ago

0.0.170

5 years ago

0.0.166

6 years ago

0.0.165

6 years ago

0.0.164

6 years ago

0.0.163

6 years ago

0.0.162

6 years ago

0.0.161

6 years ago

0.0.160

6 years ago

0.0.159

6 years ago