1.1.0 • Published 7 years ago

open_payments_cloud_application_api v1.1.0

Weekly downloads
1
License
MIT
Repository
-
Last release
7 years ago

open_payments_cloud_application_api

OpenPaymentsCloudApplicationApi - JavaScript client for open_payments_cloud_application_api Open Payments Cloud API This SDK is automatically generated by the Swagger Codegen project:

  • API version: 1.0.0
  • Package version: 1.1.0
  • Build package: io.swagger.codegen.languages.JavascriptClientCodegen For more information, please visit http://www.ixaris.com

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 open_payments_cloud_application_api --save

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.

Getting Started

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

var OpenPaymentsCloudApplicationApi = require('open_payments_cloud_application_api');

var api = new OpenPaymentsCloudApplicationApi.AuthApi()

var xProgrammeKey = "xProgrammeKey_example"; // {String} This identifies your tenant and programme within OPE. The typical format is `tenantId|programmeId`, for example `team-01|3749203750`.

var request = new OpenPaymentsCloudApplicationApi.LoginParams(); // {LoginParams} 

var opts = { 
  'xCallref': "xCallref_example" // {String} A unique call reference to provide correlation between application and system. This can be generated by your application.
};
api.authLogin(xProgrammeKey, request, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Documentation for API Endpoints

All URIs are relative to http://localhost:8324/api

ClassMethodHTTP requestDescription
OpenPaymentsCloudApplicationApi.AuthApiauthLoginPOST /auth/login
OpenPaymentsCloudApplicationApi.BankTransferSimulatorApibankTransferSimulatorIdPayinPOST /banktransfer_simulator//payin
OpenPaymentsCloudApplicationApi.BankTransferSimulatorSpiApibankTransferSimulatorSpiIdPayinPOST /banktransfer_simulator_spi//payin
OpenPaymentsCloudApplicationApi.CardProcessingSimulatorApicardProcessingSimulatorAuthorisationPOST /card_processing_simulator/authorisation
OpenPaymentsCloudApplicationApi.CardProcessingSimulatorApicardProcessingSimulatorCannedResponsesClearPOST /card_processing_simulator/canned_responses/clear
OpenPaymentsCloudApplicationApi.CardProcessingSimulatorApicardProcessingSimulatorCannedResponsesPutPOST /card_processing_simulator/canned_responses/put
OpenPaymentsCloudApplicationApi.CardProcessingSimulatorApicardProcessingSimulatorPurchasePOST /card_processing_simulator/purchase
OpenPaymentsCloudApplicationApi.CardProcessingSimulatorApicardProcessingSimulatorSettlementPOST /card_processing_simulator/settlement
OpenPaymentsCloudApplicationApi.CorporatesApicorporatesIdCreatePOST /corporates/_/create
OpenPaymentsCloudApplicationApi.CorporatesApicorporatesIdGetPOST /corporates/{id}/get
OpenPaymentsCloudApplicationApi.CorporatesApicorporatesIdUpdatePOST /corporates/{id}/update
OpenPaymentsCloudApplicationApi.CorporatesApicorporatesProfilesGetPOST /corporates/profiles/get
OpenPaymentsCloudApplicationApi.CorporatesApicorporatesProfilesIdGetPOST /corporates/profiles/{id}/get
OpenPaymentsCloudApplicationApi.CorporatesApicorporatesUsersGetPOST /corporates/users/get
OpenPaymentsCloudApplicationApi.CorporatesApicorporatesUsersIdActivatePOST /corporates/users/{id}/activate
OpenPaymentsCloudApplicationApi.CorporatesApicorporatesUsersIdCreatePOST /corporates/users/_/create
OpenPaymentsCloudApplicationApi.CorporatesApicorporatesUsersIdGetPOST /corporates/users/{id}/get
OpenPaymentsCloudApplicationApi.CorporatesApicorporatesUsersIdUpdatePOST /corporates/users/{id}/update
OpenPaymentsCloudApplicationApi.DepositsApidepositsGetPOST /deposits/get
OpenPaymentsCloudApplicationApi.DepositsApidepositsIdCreateFromExternalAccountPOST /deposits/_/create_from_external_account
OpenPaymentsCloudApplicationApi.DepositsApidepositsIdGetPOST /deposits/{id}/get
OpenPaymentsCloudApplicationApi.DepositsApidepositsProfilesGetPOST /deposits/profiles/get
OpenPaymentsCloudApplicationApi.DepositsApidepositsProfilesIdGetPOST /deposits/profiles/{id}/get
OpenPaymentsCloudApplicationApi.ExternalAccountsApiexternalAccountsGetPOST /external_accounts/get
OpenPaymentsCloudApplicationApi.ExternalAccountsApiexternalAccountsIdCreatePOST /externalaccounts//create
OpenPaymentsCloudApplicationApi.ExternalAccountsApiexternalAccountsIdGetPOST /external_accounts/{id}/get
OpenPaymentsCloudApplicationApi.ExternalAccountsApiexternalAccountsProcessedPayinsGetPOST /external_accounts/processed_payins/get
OpenPaymentsCloudApplicationApi.ExternalAccountsApiexternalAccountsProfilesGetPOST /external_accounts/profiles/get
OpenPaymentsCloudApplicationApi.ExternalAccountsApiexternalAccountsProfilesIdGetPOST /external_accounts/profiles/{id}/get
OpenPaymentsCloudApplicationApi.ManagedAccountsApimanagedAccountsGetPOST /managed_accounts/get
OpenPaymentsCloudApplicationApi.ManagedAccountsApimanagedAccountsIdCreatePOST /managedaccounts//create
OpenPaymentsCloudApplicationApi.ManagedAccountsApimanagedAccountsIdGetPOST /managed_accounts/{id}/get
OpenPaymentsCloudApplicationApi.ManagedAccountsApimanagedAccountsIdStatementGetPOST /managed_accounts/{id}/statement/get
OpenPaymentsCloudApplicationApi.ManagedAccountsApimanagedAccountsProfilesGetPOST /managed_accounts/profiles/get
OpenPaymentsCloudApplicationApi.ManagedAccountsApimanagedAccountsProfilesIdGetPOST /managed_accounts/profiles/{id}/get
OpenPaymentsCloudApplicationApi.ManagedCardsApimanagedCardsGetPOST /managed_cards/get
OpenPaymentsCloudApplicationApi.ManagedCardsApimanagedCardsIdBlockPOST /managed_cards/{id}/block
OpenPaymentsCloudApplicationApi.ManagedCardsApimanagedCardsIdCreatePOST /managedcards//create
OpenPaymentsCloudApplicationApi.ManagedCardsApimanagedCardsIdCvvGetPOST /managed_cards/{id}/cvv/get
OpenPaymentsCloudApplicationApi.ManagedCardsApimanagedCardsIdDestroyPOST /managed_cards/{id}/destroy
OpenPaymentsCloudApplicationApi.ManagedCardsApimanagedCardsIdGetPOST /managed_cards/{id}/get
OpenPaymentsCloudApplicationApi.ManagedCardsApimanagedCardsIdStatementGetPOST /managed_cards/{id}/statement/get
OpenPaymentsCloudApplicationApi.ManagedCardsApimanagedCardsIdUnblockPOST /managed_cards/{id}/unblock
OpenPaymentsCloudApplicationApi.ManagedCardsApimanagedCardsIdUpdatePOST /managed_cards/{id}/update
OpenPaymentsCloudApplicationApi.ManagedCardsApimanagedCardsProfilesGetPOST /managed_cards/profiles/get
OpenPaymentsCloudApplicationApi.ManagedCardsApimanagedCardsProfilesIdGetPOST /managed_cards/profiles/{id}/get
OpenPaymentsCloudApplicationApi.PasswordsApipasswordsCredentialIdAuthenticatedUpdatePOST /passwords/{credential_id}/authenticated_update
OpenPaymentsCloudApplicationApi.PasswordsApipasswordsCredentialIdCreatePOST /passwords/{credential_id}/create
OpenPaymentsCloudApplicationApi.PasswordsApipasswordsCredentialIdGetPOST /passwords/{credential_id}/get
OpenPaymentsCloudApplicationApi.PasswordsApipasswordsCredentialIdUpdatePOST /passwords/{credential_id}/update
OpenPaymentsCloudApplicationApi.PasswordsApipasswordsCredentialIdVersionExpirePOST /passwords/{credential_id}/{version}/expire
OpenPaymentsCloudApplicationApi.PasswordsApipasswordsIdentitiesIdentityIdGetPOST /passwords/identities/{identity_id}/get
OpenPaymentsCloudApplicationApi.PasswordsApipasswordsProfilesIdentityProfileIdGetPOST /passwords/profiles/{identity_profile_id}/get
OpenPaymentsCloudApplicationApi.TransfersApitransfersGetPOST /transfers/get
OpenPaymentsCloudApplicationApi.TransfersApitransfersIdCreatePOST /transfers/_/create
OpenPaymentsCloudApplicationApi.TransfersApitransfersIdGetPOST /transfers/{id}/get
OpenPaymentsCloudApplicationApi.TransfersApitransfersProfilesGetPOST /transfers/profiles/get
OpenPaymentsCloudApplicationApi.TransfersApitransfersProfilesIdGetPOST /transfers/profiles/{id}/get
OpenPaymentsCloudApplicationApi.WithdrawalsApiwithdrawalsGetPOST /withdrawals/get
OpenPaymentsCloudApplicationApi.WithdrawalsApiwithdrawalsIdCreateToExternalAccountPOST /withdrawals/_/create_to_external_account
OpenPaymentsCloudApplicationApi.WithdrawalsApiwithdrawalsIdGetPOST /withdrawals/{id}/get
OpenPaymentsCloudApplicationApi.WithdrawalsApiwithdrawalsProfilesGetPOST /withdrawals/profiles/get
OpenPaymentsCloudApplicationApi.WithdrawalsApiwithdrawalsProfilesIdGetPOST /withdrawals/profiles/{id}/get

Documentation for Models

Documentation for Authorization

All endpoints do not require authorization.

superagent
@infinitebrahmanuniverse/nolb-open_@everything-registry/sub-chunk-2381@zalastax/nolb-open_
1.1.0

7 years ago

1.0.1

7 years ago

1.0.0

7 years ago

0.9.1

7 years ago

0.9.0

7 years ago