# tpaycom_technical_documentation

TpaycomTechnicalDocumentation - JavaScript client for tpaycom_technical_documentation
 <p class=\"changes-disclaimer\"> Demo transaction/masspayments api key: <input type=\"text\" id=\"transaction_key\" value=\"75f86137a6635df826e3efe2e66f7c9a946fdde1\" class=\"ui-form-control\"/><label for=\"transaction_key\" style=\"display: none;\" id=\"tr_api_label\">COPIED!</label><br/><br/> Demo cards api key: <input type=\"text\" id=\"cards_key\" value=\"ba9a05faa697f9b43f39b84933ff168e373c6496\" class=\"ui-form-control\"/><label for=\"cards_key\" style=\"display: none;\" id=\"cards_api_label\">COPIED!</label><br/><br/> Demo registration api key: <input type=\"text\" id=\"registration_key\" value=\"6c0f5ef6e4d6877abad7fcfb3b5de117ad8b772d\" class=\"ui-form-control\"/><label for=\"registration_key\" style=\"display: none;\" id=\"registration_api_label\">COPIED!</label><br/><br/> The terms seller and merchant are used interchangeably and they both refer to a person or a company registered at tpay.com to accept online payments. <br/> Whenever term merchant panel is used it refers to the part of tpay.com website located at <a href=\"https://secure.tpay.com/panel\" target=\"_blank\">secure.tpay.com/panel</a>. <br/><br/> For sandbox purposes use merchant demo account <br/><br/> ID - 1010, Password - demo<br/><br/>Remember that this is a shared account, so all data passed through will be publicly visible.</p>
This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:

- API version: 1.1.2
- Package version: 1.1.2
- Build package: io.swagger.codegen.languages.JavascriptClientCodegen

## Installation

### For [Node.js](https://nodejs.org/)

#### npm

To publish the library as a [npm](https://www.npmjs.com/),
please follow the procedure in ["Publishing npm packages"](https://docs.npmjs.com/getting-started/publishing-npm-packages).

Then install it via:

```shell
npm install tpaycom_technical_documentation --save
```

##### 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:

```shell
npm install
```

Next, [link](https://docs.npmjs.com/cli/link) it globally in npm with the following, also from `JAVASCRIPT_CLIENT_DIR`:

```shell
npm link
```

Finally, switch to the directory you want to use your tpaycom_technical_documentation from, and run:

```shell
npm link /path/to/<JAVASCRIPT_CLIENT_DIR>
```

You should now be able to `require('tpaycom_technical_documentation')` in javascript files from the directory you ran the last 
command above from.

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

```shell
    npm install YOUR_USERNAME/tpaycom_technical_documentation --save
```

### For browser

The library also works in the browser environment via npm and [browserify](http://browserify.org/). 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, that's to say your javascript file where you actually 
use this library):

```shell
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:

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

## Getting Started

Please follow the [installation](#installation) instruction and execute the following JS code:

```javascript
var TpaycomTechnicalDocumentation = require('tpaycom_technical_documentation');

var api = new TpaycomTechnicalDocumentation.CardsAPIApi()

var apiKey = "apiKey_example"; // {String} The api key.

var opts = { 
  'basicData': new TpaycomTechnicalDocumentation.CheckFields() // {CheckFields} check method data
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.apiCardsApiKeyCheckPost(apiKey, opts, callback);

```

## Documentation for API Endpoints

All URIs are relative to *https://secure.tpay.com*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*TpaycomTechnicalDocumentation.CardsAPIApi* | [**apiCardsApiKeyCheckPost**](docs/CardsAPIApi.md#apiCardsApiKeyCheckPost) | **POST** /api/cards/{api_key}/check | check
*TpaycomTechnicalDocumentation.CardsAPIApi* | [**apiCardsApiKeyDeregisterPost**](docs/CardsAPIApi.md#apiCardsApiKeyDeregisterPost) | **POST** /api/cards/{api_key}/deregister | deregister
*TpaycomTechnicalDocumentation.CardsAPIApi* | [**apiCardsApiKeyPresalePost**](docs/CardsAPIApi.md#apiCardsApiKeyPresalePost) | **POST** /api/cards/{api_key}/presale | presale
*TpaycomTechnicalDocumentation.CardsAPIApi* | [**apiCardsApiKeyRefundPost**](docs/CardsAPIApi.md#apiCardsApiKeyRefundPost) | **POST** /api/cards/{api_key}/refund | refund
*TpaycomTechnicalDocumentation.CardsAPIApi* | [**apiCardsApiKeyRegisterSalePost**](docs/CardsAPIApi.md#apiCardsApiKeyRegisterSalePost) | **POST** /api/cards/{api_key}/register_sale | register sale
*TpaycomTechnicalDocumentation.CardsAPIApi* | [**apiCardsApiKeySalePost**](docs/CardsAPIApi.md#apiCardsApiKeySalePost) | **POST** /api/cards/{api_key}/sale | sale
*TpaycomTechnicalDocumentation.CardsAPIApi* | [**apiCardsApiKeySecuresalePost**](docs/CardsAPIApi.md#apiCardsApiKeySecuresalePost) | **POST** /api/cards/{api_key}/securesale | secure sale
*TpaycomTechnicalDocumentation.CardsAPIApi* | [**apiCardsApiKeyVisacheckoutFinishPost**](docs/CardsAPIApi.md#apiCardsApiKeyVisacheckoutFinishPost) | **POST** /api/cards/{api_key}/visacheckout_finish | visacheckout finish
*TpaycomTechnicalDocumentation.CardsAPIApi* | [**apiCardsApiKeyVisacheckoutPreparePost**](docs/CardsAPIApi.md#apiCardsApiKeyVisacheckoutPreparePost) | **POST** /api/cards/{api_key}/visacheckout_prepare | visacheckout prepare
*TpaycomTechnicalDocumentation.MasspaymentsApi* | [**apiGwApiKeyMasspaymentAuthorizePost**](docs/MasspaymentsApi.md#apiGwApiKeyMasspaymentAuthorizePost) | **POST** /api/gw/{api_key}/masspayment/authorize | authorize
*TpaycomTechnicalDocumentation.MasspaymentsApi* | [**apiGwApiKeyMasspaymentCreatePost**](docs/MasspaymentsApi.md#apiGwApiKeyMasspaymentCreatePost) | **POST** /api/gw/{api_key}/masspayment/create | create
*TpaycomTechnicalDocumentation.MasspaymentsApi* | [**apiGwApiKeyMasspaymentPacksPost**](docs/MasspaymentsApi.md#apiGwApiKeyMasspaymentPacksPost) | **POST** /api/gw/{api_key}/masspayment/packs | packs
*TpaycomTechnicalDocumentation.MasspaymentsApi* | [**apiGwApiKeyMasspaymentTransfersPost**](docs/MasspaymentsApi.md#apiGwApiKeyMasspaymentTransfersPost) | **POST** /api/gw/{api_key}/masspayment/transfers | transfers
*TpaycomTechnicalDocumentation.RegistrationApi* | [**apiGwApiKeyRegistrationInputsPost**](docs/RegistrationApi.md#apiGwApiKeyRegistrationInputsPost) | **POST** /api/gw/{api_key}/registration/inputs | inputs
*TpaycomTechnicalDocumentation.RegistrationApi* | [**apiGwApiKeyRegistrationRegisterPost**](docs/RegistrationApi.md#apiGwApiKeyRegistrationRegisterPost) | **POST** /api/gw/{api_key}/registration/register | register
*TpaycomTechnicalDocumentation.TransactionAPIApi* | [**apiGwApiKeyChargebackAnyPost**](docs/TransactionAPIApi.md#apiGwApiKeyChargebackAnyPost) | **POST** /api/gw/{api_key}/chargeback/any | any
*TpaycomTechnicalDocumentation.TransactionAPIApi* | [**apiGwApiKeyChargebackStatusPost**](docs/TransactionAPIApi.md#apiGwApiKeyChargebackStatusPost) | **POST** /api/gw/{api_key}/chargeback/status | status
*TpaycomTechnicalDocumentation.TransactionAPIApi* | [**apiGwApiKeyChargebackTransactionPost**](docs/TransactionAPIApi.md#apiGwApiKeyChargebackTransactionPost) | **POST** /api/gw/{api_key}/chargeback/transaction | transaction
*TpaycomTechnicalDocumentation.TransactionAPIApi* | [**apiGwApiKeyTransactionBlikPost**](docs/TransactionAPIApi.md#apiGwApiKeyTransactionBlikPost) | **POST** /api/gw/{api_key}/transaction/blik | blik
*TpaycomTechnicalDocumentation.TransactionAPIApi* | [**apiGwApiKeyTransactionCreatePost**](docs/TransactionAPIApi.md#apiGwApiKeyTransactionCreatePost) | **POST** /api/gw/{api_key}/transaction/create | create
*TpaycomTechnicalDocumentation.TransactionAPIApi* | [**apiGwApiKeyTransactionGetPost**](docs/TransactionAPIApi.md#apiGwApiKeyTransactionGetPost) | **POST** /api/gw/{api_key}/transaction/get | get
*TpaycomTechnicalDocumentation.TransactionAPIApi* | [**apiGwApiKeyTransactionReportPost**](docs/TransactionAPIApi.md#apiGwApiKeyTransactionReportPost) | **POST** /api/gw/{api_key}/transaction/report | report


## Documentation for Models

 - [TpaycomTechnicalDocumentation.Address](docs/Address.md)
 - [TpaycomTechnicalDocumentation.Amount](docs/Amount.md)
 - [TpaycomTechnicalDocumentation.ApiDataObject](docs/ApiDataObject.md)
 - [TpaycomTechnicalDocumentation.ApiPassword](docs/ApiPassword.md)
 - [TpaycomTechnicalDocumentation.BlikAlias](docs/BlikAlias.md)
 - [TpaycomTechnicalDocumentation.BlikAliasResponse](docs/BlikAliasResponse.md)
 - [TpaycomTechnicalDocumentation.BlikFields](docs/BlikFields.md)
 - [TpaycomTechnicalDocumentation.BlikResponse](docs/BlikResponse.md)
 - [TpaycomTechnicalDocumentation.BranchObject](docs/BranchObject.md)
 - [TpaycomTechnicalDocumentation.CardApiPassword](docs/CardApiPassword.md)
 - [TpaycomTechnicalDocumentation.CardsErrCode](docs/CardsErrCode.md)
 - [TpaycomTechnicalDocumentation.CardsErrDesc](docs/CardsErrDesc.md)
 - [TpaycomTechnicalDocumentation.CardsRejectionReason](docs/CardsRejectionReason.md)
 - [TpaycomTechnicalDocumentation.ChargebackStatus](docs/ChargebackStatus.md)
 - [TpaycomTechnicalDocumentation.CheckFields](docs/CheckFields.md)
 - [TpaycomTechnicalDocumentation.CheckResponse](docs/CheckResponse.md)
 - [TpaycomTechnicalDocumentation.City](docs/City.md)
 - [TpaycomTechnicalDocumentation.CliAuth](docs/CliAuth.md)
 - [TpaycomTechnicalDocumentation.Code](docs/Code.md)
 - [TpaycomTechnicalDocumentation.Country](docs/Country.md)
 - [TpaycomTechnicalDocumentation.CreateFields](docs/CreateFields.md)
 - [TpaycomTechnicalDocumentation.CreateResponse](docs/CreateResponse.md)
 - [TpaycomTechnicalDocumentation.Currency](docs/Currency.md)
 - [TpaycomTechnicalDocumentation.DeregisterFields](docs/DeregisterFields.md)
 - [TpaycomTechnicalDocumentation.Desc](docs/Desc.md)
 - [TpaycomTechnicalDocumentation.Email](docs/Email.md)
 - [TpaycomTechnicalDocumentation.GetFields](docs/GetFields.md)
 - [TpaycomTechnicalDocumentation.GetResponse](docs/GetResponse.md)
 - [TpaycomTechnicalDocumentation.InlineResponse200](docs/InlineResponse200.md)
 - [TpaycomTechnicalDocumentation.Language](docs/Language.md)
 - [TpaycomTechnicalDocumentation.LegalFormObject](docs/LegalFormObject.md)
 - [TpaycomTechnicalDocumentation.MasspaymentAuthorizeFields](docs/MasspaymentAuthorizeFields.md)
 - [TpaycomTechnicalDocumentation.MasspaymentAuthorizeResponse](docs/MasspaymentAuthorizeResponse.md)
 - [TpaycomTechnicalDocumentation.MasspaymentCreateFields](docs/MasspaymentCreateFields.md)
 - [TpaycomTechnicalDocumentation.MasspaymentCreateResponse](docs/MasspaymentCreateResponse.md)
 - [TpaycomTechnicalDocumentation.MasspaymentErrCode](docs/MasspaymentErrCode.md)
 - [TpaycomTechnicalDocumentation.MasspaymentErrDesc](docs/MasspaymentErrDesc.md)
 - [TpaycomTechnicalDocumentation.MasspaymentPacksFields](docs/MasspaymentPacksFields.md)
 - [TpaycomTechnicalDocumentation.MasspaymentPacksResponse](docs/MasspaymentPacksResponse.md)
 - [TpaycomTechnicalDocumentation.MasspaymentTransfersFields](docs/MasspaymentTransfersFields.md)
 - [TpaycomTechnicalDocumentation.MasspaymentTransfersResponse](docs/MasspaymentTransfersResponse.md)
 - [TpaycomTechnicalDocumentation.ModelDate](docs/ModelDate.md)
 - [TpaycomTechnicalDocumentation.Name](docs/Name.md)
 - [TpaycomTechnicalDocumentation.Onetimer](docs/Onetimer.md)
 - [TpaycomTechnicalDocumentation.OrderId](docs/OrderId.md)
 - [TpaycomTechnicalDocumentation.PackId](docs/PackId.md)
 - [TpaycomTechnicalDocumentation.PacksObject](docs/PacksObject.md)
 - [TpaycomTechnicalDocumentation.Phone](docs/Phone.md)
 - [TpaycomTechnicalDocumentation.PowUrl](docs/PowUrl.md)
 - [TpaycomTechnicalDocumentation.PowUrlBlad](docs/PowUrlBlad.md)
 - [TpaycomTechnicalDocumentation.PresaleFields](docs/PresaleFields.md)
 - [TpaycomTechnicalDocumentation.RefundAnyFields](docs/RefundAnyFields.md)
 - [TpaycomTechnicalDocumentation.RefundAnyResponse](docs/RefundAnyResponse.md)
 - [TpaycomTechnicalDocumentation.RefundFields](docs/RefundFields.md)
 - [TpaycomTechnicalDocumentation.RefundResponse](docs/RefundResponse.md)
 - [TpaycomTechnicalDocumentation.RefundStatusResponse](docs/RefundStatusResponse.md)
 - [TpaycomTechnicalDocumentation.RefundTransactionFields](docs/RefundTransactionFields.md)
 - [TpaycomTechnicalDocumentation.RegWrongParameters](docs/RegWrongParameters.md)
 - [TpaycomTechnicalDocumentation.RegisterFields](docs/RegisterFields.md)
 - [TpaycomTechnicalDocumentation.RegisterSaleFields](docs/RegisterSaleFields.md)
 - [TpaycomTechnicalDocumentation.RegisterSaleResponse](docs/RegisterSaleResponse.md)
 - [TpaycomTechnicalDocumentation.RegistrationApiPassword](docs/RegistrationApiPassword.md)
 - [TpaycomTechnicalDocumentation.RegistrationErrCodes](docs/RegistrationErrCodes.md)
 - [TpaycomTechnicalDocumentation.RegistrationErrDesc](docs/RegistrationErrDesc.md)
 - [TpaycomTechnicalDocumentation.RegistrationInputFields](docs/RegistrationInputFields.md)
 - [TpaycomTechnicalDocumentation.RegistrationInputsResponse](docs/RegistrationInputsResponse.md)
 - [TpaycomTechnicalDocumentation.RegistrationRegisterResponse](docs/RegistrationRegisterResponse.md)
 - [TpaycomTechnicalDocumentation.ReportFields](docs/ReportFields.md)
 - [TpaycomTechnicalDocumentation.ReportResponse](docs/ReportResponse.md)
 - [TpaycomTechnicalDocumentation.Result](docs/Result.md)
 - [TpaycomTechnicalDocumentation.SaleAuth](docs/SaleAuth.md)
 - [TpaycomTechnicalDocumentation.SaleFields](docs/SaleFields.md)
 - [TpaycomTechnicalDocumentation.SaleResponse](docs/SaleResponse.md)
 - [TpaycomTechnicalDocumentation.SecuresaleFields](docs/SecuresaleFields.md)
 - [TpaycomTechnicalDocumentation.SecuresaleResponse](docs/SecuresaleResponse.md)
 - [TpaycomTechnicalDocumentation.SellerDataObject](docs/SellerDataObject.md)
 - [TpaycomTechnicalDocumentation.Title](docs/Title.md)
 - [TpaycomTechnicalDocumentation.TransactionErrorCodes](docs/TransactionErrorCodes.md)
 - [TpaycomTechnicalDocumentation.TransfersObject](docs/TransfersObject.md)
 - [TpaycomTechnicalDocumentation.VcFinishFields](docs/VcFinishFields.md)
 - [TpaycomTechnicalDocumentation.VcFinishRequestExample](docs/VcFinishRequestExample.md)
 - [TpaycomTechnicalDocumentation.VcFinishRequestExampleInner](docs/VcFinishRequestExampleInner.md)
 - [TpaycomTechnicalDocumentation.VcFinishRequestExampleInnerPartialShippingAddress](docs/VcFinishRequestExampleInnerPartialShippingAddress.md)
 - [TpaycomTechnicalDocumentation.VcFinishRequestExampleInnerPaymentRequest](docs/VcFinishRequestExampleInnerPaymentRequest.md)
 - [TpaycomTechnicalDocumentation.VcFinishRequestExampleInnerRiskData](docs/VcFinishRequestExampleInnerRiskData.md)
 - [TpaycomTechnicalDocumentation.VcPrepareFields](docs/VcPrepareFields.md)
 - [TpaycomTechnicalDocumentation.VcPrepareResponse](docs/VcPrepareResponse.md)
 - [TpaycomTechnicalDocumentation.VcPrepareResponseExample](docs/VcPrepareResponseExample.md)
 - [TpaycomTechnicalDocumentation.VcPrepareResponseExampleInner](docs/VcPrepareResponseExampleInner.md)
 - [TpaycomTechnicalDocumentation.VcPrepareResponseExampleInnerUserData](docs/VcPrepareResponseExampleInnerUserData.md)


## Documentation for Authorization

 All endpoints do not require authorization.