Tsumanu/bazzar
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
a3dd9b85d8
bazzar/vendor/t_pay/docs/TransactionAPIApi.md

233 lines
9.1 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# \TransactionAPIApi
All URIs are relative to *https://docs.tpay.com/Proxy.php*
Method | HTTP request | Description
------------- | ------------- | -------------
[**api_gw_api_key_chargeback_any_post**](TransactionAPIApi.md#api_gw_api_key_chargeback_any_post) | **POST** /api/gw/{api_key}/chargeback/any | any
[**api_gw_api_key_chargeback_status_post**](TransactionAPIApi.md#api_gw_api_key_chargeback_status_post) | **POST** /api/gw/{api_key}/chargeback/status | status
[**api_gw_api_key_chargeback_transaction_post**](TransactionAPIApi.md#api_gw_api_key_chargeback_transaction_post) | **POST** /api/gw/{api_key}/chargeback/transaction | transaction
[**api_gw_api_key_transaction_blik_post**](TransactionAPIApi.md#api_gw_api_key_transaction_blik_post) | **POST** /api/gw/{api_key}/transaction/blik | blik
[**api_gw_api_key_transaction_create_post**](TransactionAPIApi.md#api_gw_api_key_transaction_create_post) | **POST** /api/gw/{api_key}/transaction/create | create
[**api_gw_api_key_transaction_get_post**](TransactionAPIApi.md#api_gw_api_key_transaction_get_post) | **POST** /api/gw/{api_key}/transaction/get | get
[**api_gw_api_key_transaction_report_post**](TransactionAPIApi.md#api_gw_api_key_transaction_report_post) | **POST** /api/gw/{api_key}/transaction/report | report
## api_gw_api_key_chargeback_any_post
> crate::models::RefundAnyResponse api_gw_api_key_chargeback_any_post(api_key, refund_any_data)
any
The method used to refund part of the transaction amount. <br/><br/><b>NOTICE:</b> This method works only in production mode!<br/>To test this method, you need to create the transaction in production mode with your own API access.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**api_key** | **String** | The api key. | [required] |
**refund_any_data** | Option<[**RefundAnyFields**](RefundAnyFields.md)> | Request body. | |
### Return type
[**crate::models::RefundAnyResponse**](refund_any_response.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: */*
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## api_gw_api_key_chargeback_status_post
> crate::models::RefundStatusResponse api_gw_api_key_chargeback_status_post(api_key, refund_transaction_data)
status
The method used to check transaction refunds statuses.<br/>Some refunds statuses may be not available immediately after calling refund methods due to gathering refund details process.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**api_key** | **String** | The api key. | [required] |
**refund_transaction_data** | Option<[**RefundTransactionFields**](RefundTransactionFields.md)> | Request body. | |
### Return type
[**crate::models::RefundStatusResponse**](refund_status_response.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: */*
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## api_gw_api_key_chargeback_transaction_post
> crate::models::RefundAnyResponse api_gw_api_key_chargeback_transaction_post(api_key, refund_transaction_data)
transaction
The method used to refund full transaction amount. You can get transaction title from 'create' method when generating the transaction.<br/><br/><b>NOTICE:</b> This method works only in production mode!<br/>To test this method, you need to create the transaction in production mode with your own API access.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**api_key** | **String** | The api key. | [required] |
**refund_transaction_data** | Option<[**RefundTransactionFields**](RefundTransactionFields.md)> | Request body. | |
### Return type
[**crate::models::RefundAnyResponse**](refund_any_response.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: */*
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## api_gw_api_key_transaction_blik_post
> crate::models::BlikResponse api_gw_api_key_transaction_blik_post(api_key, blik_data)
blik
This method allows sending a BLIK code in direct communication between merchant and BLIK system. In ‘create’ method you should set 150 as a value for parameter ‘group’, this is a BLIK payment channel. Method returns parameter ‘result’ equal to 1 which means that payment popup has been successfully displayed at customer mobile application. After accepting payment by the customer, tpay.com system sends a standard notification to merchant's endpoint declared in wyn_url parameter (this parameter should be sent in 'create' method.)<br/><br/><b>NOTICE:</b> to test this method, you need to create the transaction with 'create' method and replace title parameter value with the returned title.<br/>Blik method works with the specific set of parameters depending on payment type case. Please see BLIK workflow section.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**api_key** | **String** | The api key. | [required] |
**blik_data** | Option<[**BlikFields**](BlikFields.md)> | Request body. | |
### Return type
[**crate::models::BlikResponse**](blik_response.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: */*
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## api_gw_api_key_transaction_create_post
> crate::models::CreateResponse api_gw_api_key_transaction_create_post(api_key, basic_data)
create
This method allows you to prepare transaction for a customer. The method returns transaction title required for other API methods and redirection link for a customer.<br/>This method also returns account details for manual money transfers.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**api_key** | **String** | The api key. | [required] |
**basic_data** | Option<[**CreateFields**](CreateFields.md)> | Transaction data. | |
### Return type
[**crate::models::CreateResponse**](create_response.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: */*
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## api_gw_api_key_transaction_get_post
> crate::models::GetResponse api_gw_api_key_transaction_get_post(api_key, get_data)
get
This method allows you to get all information about the transaction by sending previously generated title.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**api_key** | **String** | The api key. | [required] |
**get_data** | Option<[**GetFields**](GetFields.md)> | Request body. | |
### Return type
[**crate::models::GetResponse**](get_response.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: */*
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## api_gw_api_key_transaction_report_post
> crate::models::ReportResponse api_gw_api_key_transaction_report_post(api_key, report_data)
report
This method returns payments report for the declared time range, generated in CSV format (semicolon separators) and encoded in base64 - the same format as in merchant panel. If you like to arrange result as an associative array, you can use the ready <a href=\"https://github.com/tpay-com/tpay-php/blob/master/tpayLibs/examples/TransactionReportsApi.php\" target=\"_blank\">script</a> from Tpay PHP library.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**api_key** | **String** | The api key. | [required] |
**report_data** | Option<[**ReportFields**](ReportFields.md)> | Request body. | |
### Return type
[**crate::models::ReportResponse**](report_response.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: */*
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
Reference in New Issue View Git Blame Copy Permalink