❤
npm
Sign UpSign In

sumup-rest-api

1.0.1 • Public • Published

This repo is generated using Swagger Codegen

SumUp REST API

SumUpRestApi - JavaScript client for sumup-rest-api SumUp’s REST API operates with application/json HTTP requests and response. The request bodies are sent through resource-oriented URLs and use the standard HTTP response codes. For testing our APIs, please contact us for a test account. When you receive your test account you can create your client credentials and process different requests with real payment instruments, without charging them. # Authentication This SDK is automatically generated by the Swagger Codegen project:

  • API version: 1.0.0
  • Package version: 1.0.0
  • Build package: io.swagger.codegen.v3.generators.javascript.JavaScriptClientCodegen

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 sumup-rest-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.

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 SumUpRestApi = require('sumup-rest-api');
var defaultClient = SumUpRestApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: accessToken
var accessToken = defaultClient.authentications['accessToken'];
accessToken.accessToken = "YOUR ACCESS TOKEN"

var api = new SumUpRestApi.AccountDetailsApi()
var opts = { 
  'include': ["include_example"] // {[String]} A list of additional information you want to receive for the user. By default only personal and merchant profile information will be returned.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.meGet(opts, callback);

Documentation for API Endpoints

All URIs are relative to https://api.sumup.com/{version}

Class Method HTTP request Description
SumUpRestApi.AccountDetailsApi meGet GET /me Retrieve an account
SumUpRestApi.AuthorizationApi authorizeGet GET /authorize Request authorization from users
SumUpRestApi.AuthorizationApi tokenPost POST /token Generate a token
SumUpRestApi.CheckoutsApi checkoutsGet GET /checkouts List checkouts
SumUpRestApi.CheckoutsApi checkoutsIdDelete DELETE /checkouts/{id} Deactivate a checkout
SumUpRestApi.CheckoutsApi checkoutsIdGet GET /checkouts/{id} Retrieve a checkout
SumUpRestApi.CheckoutsApi checkoutsIdPut PUT /checkouts/{id} Process a checkout
SumUpRestApi.CheckoutsApi checkoutsPost POST /checkouts Create a checkout
SumUpRestApi.CustomersApi customersCustomerIdGet GET /customers/{customer_id} Retrieve a customer
SumUpRestApi.CustomersApi customersCustomerIdPaymentInstrumentsGet GET /customers/{customer_id}/payment-instruments List payment instruments
SumUpRestApi.CustomersApi customersCustomerIdPaymentInstrumentsPost POST /customers/{customer_id}/payment-instruments Create a payment instrument
SumUpRestApi.CustomersApi customersCustomerIdPaymentInstrumentsTokenDelete DELETE /customers/{customer_id}/payment-instruments/{token} Deactivate a payment instrument
SumUpRestApi.CustomersApi customersCustomerIdPut PUT /customers/{customer_id} Update a customer
SumUpRestApi.CustomersApi customersPost POST /customers Create a customer
SumUpRestApi.MerchantAccountApi meMerchantProfileBankAccountsGet GET /me/merchant-profile/bank-accounts List bank accounts
SumUpRestApi.MerchantAccountApi meMerchantProfileDoingBusinessAsGet GET /me/merchant-profile/doing-business-as Retrieve DBA
SumUpRestApi.MerchantAccountApi meMerchantProfileGet GET /me/merchant-profile Retrieve a profile
SumUpRestApi.MerchantAccountApi meMerchantProfileSettingsGet GET /me/merchant-profile/settings List settings
SumUpRestApi.PayoutsApi meFinancialsPayoutsGet GET /me/financials/payouts List payouts
SumUpRestApi.PayoutsApi meFinancialsTransactionsGet GET /me/financials/transactions List transactions
SumUpRestApi.PersonalAccountApi mePersonalProfileGet GET /me/personal-profile Retrieve a profile
SumUpRestApi.ReceiptsApi receiptsIdGet GET /receipts/{id} Retrieve receipt details
SumUpRestApi.RefundsApi meRefundTxnIdPost POST /me/refund/{txn_id} Refund a transaction
SumUpRestApi.SubaccountsApi meAccountsGet GET /me/accounts List subaccounts
SumUpRestApi.SubaccountsApi meAccountsOperatorCodeDelete DELETE /me/accounts/{operator_code} Deactivate a subaccount
SumUpRestApi.SubaccountsApi meAccountsOperatorCodePut PUT /me/accounts/{operator_code} Update a subaccount
SumUpRestApi.SubaccountsApi meAccountsPost POST /me/accounts Create a subaccount
SumUpRestApi.TransactionsApi meTransactionsGet GET /me/transactions Retrieve a transaction
SumUpRestApi.TransactionsApi meTransactionsHistoryGet GET /me/transactions/history List transactions

Documentation for Models

Documentation for Authorization

accessToken

  • Type: OAuth
  • Flow: application
  • Authorization URL:
  • Scopes:
    • :

Readme

Keywords

none

Package Sidebar

Install

npm i sumup-rest-api

Repository

github.com/yauri-io/sumup-js-sdk

Homepage

github.com/yauri-io/sumup-js-sdk#readme

Weekly Downloads

0

Version

1.0.1

License

MIT

Unpacked Size

1.1 MB

Total Files

369

Last publish

Collaborators

  • y-io
Try on RunKit
Report malware