tpaycom_technical_documentation
v1.1.2
Published
_p_classchanges_disclaimer_Demo_transactionmasspayments_api_key_input_typetext_idtransaction_key_value75f86137a6635df826e3efe2e66f7c9a946fdde1_classui_form_controllabel_fortransaction_key_styledisplay_none_idtr_api_labelCOPIEDlabelbrbr_Demo_cards_api_key_
Downloads
3
Readme
tpaycom_technical_documentation
TpaycomTechnicalDocumentation - JavaScript client for tpaycom_technical_documentation
- API version: 1.1.2
- Package version: 1.1.2
- Build package: io.swagger.codegen.languages.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 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:
npm install
Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR
:
npm link
Finally, switch to the directory you want to use your tpaycom_technical_documentation from, and run:
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:
npm install YOUR_USERNAME/tpaycom_technical_documentation --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, that's to say your javascript file where you actually
use this library):
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 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 | POST /api/cards/{api_key}/check | check TpaycomTechnicalDocumentation.CardsAPIApi | apiCardsApiKeyDeregisterPost | POST /api/cards/{api_key}/deregister | deregister TpaycomTechnicalDocumentation.CardsAPIApi | apiCardsApiKeyPresalePost | POST /api/cards/{api_key}/presale | presale TpaycomTechnicalDocumentation.CardsAPIApi | apiCardsApiKeyRefundPost | POST /api/cards/{api_key}/refund | refund TpaycomTechnicalDocumentation.CardsAPIApi | apiCardsApiKeyRegisterSalePost | POST /api/cards/{api_key}/register_sale | register sale TpaycomTechnicalDocumentation.CardsAPIApi | apiCardsApiKeySalePost | POST /api/cards/{api_key}/sale | sale TpaycomTechnicalDocumentation.CardsAPIApi | apiCardsApiKeySecuresalePost | POST /api/cards/{api_key}/securesale | secure sale TpaycomTechnicalDocumentation.CardsAPIApi | apiCardsApiKeyVisacheckoutFinishPost | POST /api/cards/{api_key}/visacheckout_finish | visacheckout finish TpaycomTechnicalDocumentation.CardsAPIApi | apiCardsApiKeyVisacheckoutPreparePost | POST /api/cards/{api_key}/visacheckout_prepare | visacheckout prepare TpaycomTechnicalDocumentation.MasspaymentsApi | apiGwApiKeyMasspaymentAuthorizePost | POST /api/gw/{api_key}/masspayment/authorize | authorize TpaycomTechnicalDocumentation.MasspaymentsApi | apiGwApiKeyMasspaymentCreatePost | POST /api/gw/{api_key}/masspayment/create | create TpaycomTechnicalDocumentation.MasspaymentsApi | apiGwApiKeyMasspaymentPacksPost | POST /api/gw/{api_key}/masspayment/packs | packs TpaycomTechnicalDocumentation.MasspaymentsApi | apiGwApiKeyMasspaymentTransfersPost | POST /api/gw/{api_key}/masspayment/transfers | transfers TpaycomTechnicalDocumentation.RegistrationApi | apiGwApiKeyRegistrationInputsPost | POST /api/gw/{api_key}/registration/inputs | inputs TpaycomTechnicalDocumentation.RegistrationApi | apiGwApiKeyRegistrationRegisterPost | POST /api/gw/{api_key}/registration/register | register TpaycomTechnicalDocumentation.TransactionAPIApi | apiGwApiKeyChargebackAnyPost | POST /api/gw/{api_key}/chargeback/any | any TpaycomTechnicalDocumentation.TransactionAPIApi | apiGwApiKeyChargebackStatusPost | POST /api/gw/{api_key}/chargeback/status | status TpaycomTechnicalDocumentation.TransactionAPIApi | apiGwApiKeyChargebackTransactionPost | POST /api/gw/{api_key}/chargeback/transaction | transaction TpaycomTechnicalDocumentation.TransactionAPIApi | apiGwApiKeyTransactionBlikPost | POST /api/gw/{api_key}/transaction/blik | blik TpaycomTechnicalDocumentation.TransactionAPIApi | apiGwApiKeyTransactionCreatePost | POST /api/gw/{api_key}/transaction/create | create TpaycomTechnicalDocumentation.TransactionAPIApi | apiGwApiKeyTransactionGetPost | POST /api/gw/{api_key}/transaction/get | get TpaycomTechnicalDocumentation.TransactionAPIApi | apiGwApiKeyTransactionReportPost | POST /api/gw/{api_key}/transaction/report | report
Documentation for Models
- TpaycomTechnicalDocumentation.Address
- TpaycomTechnicalDocumentation.Amount
- TpaycomTechnicalDocumentation.ApiDataObject
- TpaycomTechnicalDocumentation.ApiPassword
- TpaycomTechnicalDocumentation.BlikAlias
- TpaycomTechnicalDocumentation.BlikAliasResponse
- TpaycomTechnicalDocumentation.BlikFields
- TpaycomTechnicalDocumentation.BlikResponse
- TpaycomTechnicalDocumentation.BranchObject
- TpaycomTechnicalDocumentation.CardApiPassword
- TpaycomTechnicalDocumentation.CardsErrCode
- TpaycomTechnicalDocumentation.CardsErrDesc
- TpaycomTechnicalDocumentation.CardsRejectionReason
- TpaycomTechnicalDocumentation.ChargebackStatus
- TpaycomTechnicalDocumentation.CheckFields
- TpaycomTechnicalDocumentation.CheckResponse
- TpaycomTechnicalDocumentation.City
- TpaycomTechnicalDocumentation.CliAuth
- TpaycomTechnicalDocumentation.Code
- TpaycomTechnicalDocumentation.Country
- TpaycomTechnicalDocumentation.CreateFields
- TpaycomTechnicalDocumentation.CreateResponse
- TpaycomTechnicalDocumentation.Currency
- TpaycomTechnicalDocumentation.DeregisterFields
- TpaycomTechnicalDocumentation.Desc
- TpaycomTechnicalDocumentation.Email
- TpaycomTechnicalDocumentation.GetFields
- TpaycomTechnicalDocumentation.GetResponse
- TpaycomTechnicalDocumentation.InlineResponse200
- TpaycomTechnicalDocumentation.Language
- TpaycomTechnicalDocumentation.LegalFormObject
- TpaycomTechnicalDocumentation.MasspaymentAuthorizeFields
- TpaycomTechnicalDocumentation.MasspaymentAuthorizeResponse
- TpaycomTechnicalDocumentation.MasspaymentCreateFields
- TpaycomTechnicalDocumentation.MasspaymentCreateResponse
- TpaycomTechnicalDocumentation.MasspaymentErrCode
- TpaycomTechnicalDocumentation.MasspaymentErrDesc
- TpaycomTechnicalDocumentation.MasspaymentPacksFields
- TpaycomTechnicalDocumentation.MasspaymentPacksResponse
- TpaycomTechnicalDocumentation.MasspaymentTransfersFields
- TpaycomTechnicalDocumentation.MasspaymentTransfersResponse
- TpaycomTechnicalDocumentation.ModelDate
- TpaycomTechnicalDocumentation.Name
- TpaycomTechnicalDocumentation.Onetimer
- TpaycomTechnicalDocumentation.OrderId
- TpaycomTechnicalDocumentation.PackId
- TpaycomTechnicalDocumentation.PacksObject
- TpaycomTechnicalDocumentation.Phone
- TpaycomTechnicalDocumentation.PowUrl
- TpaycomTechnicalDocumentation.PowUrlBlad
- TpaycomTechnicalDocumentation.PresaleFields
- TpaycomTechnicalDocumentation.RefundAnyFields
- TpaycomTechnicalDocumentation.RefundAnyResponse
- TpaycomTechnicalDocumentation.RefundFields
- TpaycomTechnicalDocumentation.RefundResponse
- TpaycomTechnicalDocumentation.RefundStatusResponse
- TpaycomTechnicalDocumentation.RefundTransactionFields
- TpaycomTechnicalDocumentation.RegWrongParameters
- TpaycomTechnicalDocumentation.RegisterFields
- TpaycomTechnicalDocumentation.RegisterSaleFields
- TpaycomTechnicalDocumentation.RegisterSaleResponse
- TpaycomTechnicalDocumentation.RegistrationApiPassword
- TpaycomTechnicalDocumentation.RegistrationErrCodes
- TpaycomTechnicalDocumentation.RegistrationErrDesc
- TpaycomTechnicalDocumentation.RegistrationInputFields
- TpaycomTechnicalDocumentation.RegistrationInputsResponse
- TpaycomTechnicalDocumentation.RegistrationRegisterResponse
- TpaycomTechnicalDocumentation.ReportFields
- TpaycomTechnicalDocumentation.ReportResponse
- TpaycomTechnicalDocumentation.Result
- TpaycomTechnicalDocumentation.SaleAuth
- TpaycomTechnicalDocumentation.SaleFields
- TpaycomTechnicalDocumentation.SaleResponse
- TpaycomTechnicalDocumentation.SecuresaleFields
- TpaycomTechnicalDocumentation.SecuresaleResponse
- TpaycomTechnicalDocumentation.SellerDataObject
- TpaycomTechnicalDocumentation.Title
- TpaycomTechnicalDocumentation.TransactionErrorCodes
- TpaycomTechnicalDocumentation.TransfersObject
- TpaycomTechnicalDocumentation.VcFinishFields
- TpaycomTechnicalDocumentation.VcFinishRequestExample
- TpaycomTechnicalDocumentation.VcFinishRequestExampleInner
- TpaycomTechnicalDocumentation.VcFinishRequestExampleInnerPartialShippingAddress
- TpaycomTechnicalDocumentation.VcFinishRequestExampleInnerPaymentRequest
- TpaycomTechnicalDocumentation.VcFinishRequestExampleInnerRiskData
- TpaycomTechnicalDocumentation.VcPrepareFields
- TpaycomTechnicalDocumentation.VcPrepareResponse
- TpaycomTechnicalDocumentation.VcPrepareResponseExample
- TpaycomTechnicalDocumentation.VcPrepareResponseExampleInner
- TpaycomTechnicalDocumentation.VcPrepareResponseExampleInnerUserData
Documentation for Authorization
All endpoints do not require authorization.