113 lines
7.7 KiB
Markdown
113 lines
7.7 KiB
Markdown
# Rust API client for openapi
|
|
|
|
<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=\"bda5eda723bf1ae71a82e90a249803d3f852248d\" class=\"ui-form-control\"/><label for=\"cards_key\" style=\"display: none;\" id=\"cards_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>
|
|
|
|
## Overview
|
|
|
|
This API client was generated by the [OpenAPI Generator](https://openapi-generator.tech) project. By using the [openapi-spec](https://openapis.org) from a remote server, you can easily generate an API client.
|
|
|
|
- API version: 1.2.1
|
|
- Package version: 1.0.0
|
|
- Build package: org.openapitools.codegen.languages.RustClientCodegen
|
|
|
|
## Installation
|
|
|
|
Put the package under your project folder and add the following to `Cargo.toml` under `[dependencies]`:
|
|
|
|
```
|
|
openapi = { path = "./generated" }
|
|
```
|
|
|
|
## Documentation for API Endpoints
|
|
|
|
All URIs are relative to *https://docs.tpay.com/Proxy.php*
|
|
|
|
Class | Method | HTTP request | Description
|
|
------------ | ------------- | ------------- | -------------
|
|
*CardsAPIApi* | [**api_cards_api_key_check_post**](docs/CardsAPIApi.md#api_cards_api_key_check_post) | **POST** /api/cards/{api_key}/check | check
|
|
*CardsAPIApi* | [**api_cards_api_key_deregister_post**](docs/CardsAPIApi.md#api_cards_api_key_deregister_post) | **POST** /api/cards/{api_key}/deregister | deregister
|
|
*CardsAPIApi* | [**api_cards_api_key_presale_post**](docs/CardsAPIApi.md#api_cards_api_key_presale_post) | **POST** /api/cards/{api_key}/presale | presale
|
|
*CardsAPIApi* | [**api_cards_api_key_refund_post**](docs/CardsAPIApi.md#api_cards_api_key_refund_post) | **POST** /api/cards/{api_key}/refund | refund
|
|
*CardsAPIApi* | [**api_cards_api_key_register_sale_post**](docs/CardsAPIApi.md#api_cards_api_key_register_sale_post) | **POST** /api/cards/{api_key}/register_sale | register sale
|
|
*CardsAPIApi* | [**api_cards_api_key_sale_post**](docs/CardsAPIApi.md#api_cards_api_key_sale_post) | **POST** /api/cards/{api_key}/sale | sale
|
|
*CardsAPIApi* | [**api_cards_api_key_securesale_post**](docs/CardsAPIApi.md#api_cards_api_key_securesale_post) | **POST** /api/cards/{api_key}/securesale | secure sale
|
|
*CardsAPIApi* | [**api_cards_api_key_visacheckout_finish_post**](docs/CardsAPIApi.md#api_cards_api_key_visacheckout_finish_post) | **POST** /api/cards/{api_key}/visacheckout_finish | visacheckout finish
|
|
*CardsAPIApi* | [**api_cards_api_key_visacheckout_prepare_post**](docs/CardsAPIApi.md#api_cards_api_key_visacheckout_prepare_post) | **POST** /api/cards/{api_key}/visacheckout_prepare | visacheckout prepare
|
|
*MasspaymentsApi* | [**api_gw_api_key_masspayment_authorize_post**](docs/MasspaymentsApi.md#api_gw_api_key_masspayment_authorize_post) | **POST** /api/gw/{api_key}/masspayment/authorize | authorize
|
|
*MasspaymentsApi* | [**api_gw_api_key_masspayment_create_post**](docs/MasspaymentsApi.md#api_gw_api_key_masspayment_create_post) | **POST** /api/gw/{api_key}/masspayment/create | create
|
|
*MasspaymentsApi* | [**api_gw_api_key_masspayment_packs_post**](docs/MasspaymentsApi.md#api_gw_api_key_masspayment_packs_post) | **POST** /api/gw/{api_key}/masspayment/packs | packs
|
|
*MasspaymentsApi* | [**api_gw_api_key_masspayment_transfers_post**](docs/MasspaymentsApi.md#api_gw_api_key_masspayment_transfers_post) | **POST** /api/gw/{api_key}/masspayment/transfers | transfers
|
|
*TransactionAPIApi* | [**api_gw_api_key_chargeback_any_post**](docs/TransactionAPIApi.md#api_gw_api_key_chargeback_any_post) | **POST** /api/gw/{api_key}/chargeback/any | any
|
|
*TransactionAPIApi* | [**api_gw_api_key_chargeback_status_post**](docs/TransactionAPIApi.md#api_gw_api_key_chargeback_status_post) | **POST** /api/gw/{api_key}/chargeback/status | status
|
|
*TransactionAPIApi* | [**api_gw_api_key_chargeback_transaction_post**](docs/TransactionAPIApi.md#api_gw_api_key_chargeback_transaction_post) | **POST** /api/gw/{api_key}/chargeback/transaction | transaction
|
|
*TransactionAPIApi* | [**api_gw_api_key_transaction_blik_post**](docs/TransactionAPIApi.md#api_gw_api_key_transaction_blik_post) | **POST** /api/gw/{api_key}/transaction/blik | blik
|
|
*TransactionAPIApi* | [**api_gw_api_key_transaction_create_post**](docs/TransactionAPIApi.md#api_gw_api_key_transaction_create_post) | **POST** /api/gw/{api_key}/transaction/create | create
|
|
*TransactionAPIApi* | [**api_gw_api_key_transaction_get_post**](docs/TransactionAPIApi.md#api_gw_api_key_transaction_get_post) | **POST** /api/gw/{api_key}/transaction/get | get
|
|
*TransactionAPIApi* | [**api_gw_api_key_transaction_report_post**](docs/TransactionAPIApi.md#api_gw_api_key_transaction_report_post) | **POST** /api/gw/{api_key}/transaction/report | report
|
|
|
|
|
|
## Documentation For Models
|
|
|
|
- [BlikAlias](docs/BlikAlias.md)
|
|
- [BlikAliasResponse](docs/BlikAliasResponse.md)
|
|
- [BlikFields](docs/BlikFields.md)
|
|
- [BlikResponse](docs/BlikResponse.md)
|
|
- [CardsErrCode](docs/CardsErrCode.md)
|
|
- [ChargebackStatus](docs/ChargebackStatus.md)
|
|
- [CheckFields](docs/CheckFields.md)
|
|
- [CheckResponse](docs/CheckResponse.md)
|
|
- [CreateFields](docs/CreateFields.md)
|
|
- [CreateResponse](docs/CreateResponse.md)
|
|
- [DeregisterFields](docs/DeregisterFields.md)
|
|
- [GetFields](docs/GetFields.md)
|
|
- [GetResponse](docs/GetResponse.md)
|
|
- [Language](docs/Language.md)
|
|
- [MasspaymentAuthorizeFields](docs/MasspaymentAuthorizeFields.md)
|
|
- [MasspaymentAuthorizeResponse](docs/MasspaymentAuthorizeResponse.md)
|
|
- [MasspaymentCreateFields](docs/MasspaymentCreateFields.md)
|
|
- [MasspaymentCreateResponse](docs/MasspaymentCreateResponse.md)
|
|
- [MasspaymentErrCode](docs/MasspaymentErrCode.md)
|
|
- [MasspaymentErrDesc](docs/MasspaymentErrDesc.md)
|
|
- [MasspaymentPacksFields](docs/MasspaymentPacksFields.md)
|
|
- [MasspaymentPacksResponse](docs/MasspaymentPacksResponse.md)
|
|
- [MasspaymentTransfersFields](docs/MasspaymentTransfersFields.md)
|
|
- [MasspaymentTransfersResponse](docs/MasspaymentTransfersResponse.md)
|
|
- [Onetimer](docs/Onetimer.md)
|
|
- [PacksObject](docs/PacksObject.md)
|
|
- [PaymentAttempts](docs/PaymentAttempts.md)
|
|
- [PresaleFields](docs/PresaleFields.md)
|
|
- [RefundAnyFields](docs/RefundAnyFields.md)
|
|
- [RefundAnyResponse](docs/RefundAnyResponse.md)
|
|
- [RefundFields](docs/RefundFields.md)
|
|
- [RefundResponse](docs/RefundResponse.md)
|
|
- [RefundStatusResponse](docs/RefundStatusResponse.md)
|
|
- [RefundTransactionFields](docs/RefundTransactionFields.md)
|
|
- [RegisterSaleFields](docs/RegisterSaleFields.md)
|
|
- [RegisterSaleResponse](docs/RegisterSaleResponse.md)
|
|
- [ReportFields](docs/ReportFields.md)
|
|
- [ReportResponse](docs/ReportResponse.md)
|
|
- [Result](docs/Result.md)
|
|
- [SaleFields](docs/SaleFields.md)
|
|
- [SaleResponse](docs/SaleResponse.md)
|
|
- [SecuresaleFields](docs/SecuresaleFields.md)
|
|
- [SecuresaleResponse](docs/SecuresaleResponse.md)
|
|
- [TransactionErrorCodes](docs/TransactionErrorCodes.md)
|
|
- [TransfersObject](docs/TransfersObject.md)
|
|
- [VcFinishFields](docs/VcFinishFields.md)
|
|
- [VcPrepareFields](docs/VcPrepareFields.md)
|
|
- [VcPrepareResponse](docs/VcPrepareResponse.md)
|
|
|
|
|
|
To get access to the crate's generated documentation, use:
|
|
|
|
```
|
|
cargo doc --open
|
|
```
|
|
|
|
## Author
|
|
|
|
pt@tpay.com
|
|
|