137 lines
6.6 KiB
Markdown
137 lines
6.6 KiB
Markdown
|
# \MasspaymentsApi
|
|||
|
|
|
|||
|
|
All URIs are relative to *https://docs.tpay.com/Proxy.php*
|
|||
|
|
|
|||
|
|
Method | HTTP request | Description
|
|||
|
|
------------- | ------------- | -------------
|
|||
|
|
[**api_gw_api_key_masspayment_authorize_post**](MasspaymentsApi.md#api_gw_api_key_masspayment_authorize_post) | **POST** /api/gw/{api_key}/masspayment/authorize | authorize
|
|||
|
|
[**api_gw_api_key_masspayment_create_post**](MasspaymentsApi.md#api_gw_api_key_masspayment_create_post) | **POST** /api/gw/{api_key}/masspayment/create | create
|
|||
|
|
[**api_gw_api_key_masspayment_packs_post**](MasspaymentsApi.md#api_gw_api_key_masspayment_packs_post) | **POST** /api/gw/{api_key}/masspayment/packs | packs
|
|||
|
|
[**api_gw_api_key_masspayment_transfers_post**](MasspaymentsApi.md#api_gw_api_key_masspayment_transfers_post) | **POST** /api/gw/{api_key}/masspayment/transfers | transfers
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
## api_gw_api_key_masspayment_authorize_post
|
|||
|
|
|
|||
|
|
> crate::models::MasspaymentAuthorizeResponse api_gw_api_key_masspayment_authorize_post(api_key, basic_data)
|
|||
|
|
authorize
|
|||
|
|
|
|||
|
|
This method authorizes the processing of chosen pack of transfers.
|
|||
|
|
|
|||
|
|
### Parameters
|
|||
|
|
|
|||
|
|
|
|||
|
|
Name | Type | Description | Required | Notes
|
|||
|
|
------------- | ------------- | ------------- | ------------- | -------------
|
|||
|
|
**api_key** | **String** | The api key. | [required] |
|
|||
|
|
**basic_data** | Option<[**MasspaymentAuthorizeFields**](MasspaymentAuthorizeFields.md)> | Transaction data. | |
|
|||
|
|
|
|||
|
|
### Return type
|
|||
|
|
|
|||
|
|
[**crate::models::MasspaymentAuthorizeResponse**](masspayment_authorize_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_masspayment_create_post
|
|||
|
|
|
|||
|
|
> crate::models::MasspaymentCreateResponse api_gw_api_key_masspayment_create_post(api_key, basic_data)
|
|||
|
|
create
|
|||
|
|
|
|||
|
|
This method adds a pack of transfers to the Tpay system. After executing a correct operation, you need to request authorize method to confirm payout processing. Transfers are being made once a day on workdays. You can find confirmation code in Merchant Panel, settings tab-> notifications. Variable $seller_id is Merchant’s ID in tpay.com system. <br/><br/> <b>Example CSV file</b><br/> Each line contains one transfer formatted as in the example below. Columns are separated by a semicolon. <br/> The file does not have a header.<br/><br/> account number (26 digits);receiver (part 1) (35 characters);receiver (part 2) (35 characters);receiver (part 3) (35 characters);receiver (part 4) (35 characters);amount (dot or comma separator);title (part 1) (35 characters);title (part 2) (35 characters);Tpay transaction ID<br/><br/> Place transfer receiver name in 1-4 receiver fields. Each field can be maximum 35 characters long.<br/> If receiver name is for example 40 characters long, you should put 35 in receiver 1 field, and 5 characters in receiver 2 field.<br/> The same rule is valid for title field. The transaction ID field is not required, whithout this field, the file format looks like this: <br/><br/> account number (26 digits);receiver (part 1) (35 characters);receiver (part 2) (35 characters);receiver (part 3) (35 characters);receiver (part 4) (35 characters);amount (dot or comma separator);title (part 1) (35 characters);title (part 2) (35 characters);Transaction ID from merchant system<br/><br/> Example CSV file can be downloaded from:<br/> <a href=\"https://secure.tpay.com/partner/pliki/przyklad.csv\" target=\"_blank\">Download</a>
|
|||
|
|
|
|||
|
|
### Parameters
|
|||
|
|
|
|||
|
|
|
|||
|
|
Name | Type | Description | Required | Notes
|
|||
|
|
------------- | ------------- | ------------- | ------------- | -------------
|
|||
|
|
**api_key** | **String** | The api key. | [required] |
|
|||
|
|
**basic_data** | Option<[**MasspaymentCreateFields**](MasspaymentCreateFields.md)> | Transaction data. | |
|
|||
|
|
|
|||
|
|
### Return type
|
|||
|
|
|
|||
|
|
[**crate::models::MasspaymentCreateResponse**](masspayment_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_masspayment_packs_post
|
|||
|
|
|
|||
|
|
> crate::models::MasspaymentPacksResponse api_gw_api_key_masspayment_packs_post(api_key, basic_data)
|
|||
|
|
packs
|
|||
|
|
|
|||
|
|
This method allows browsing through created packages. If none of the parameters has been sent, all packages for the Merchant’s account will be returned. If any records exist, there will be pack objects in pack section representing respective transfer packages. You can send pack_id to browse contents of specific pack or send time range to browse all packages within time range
|
|||
|
|
|
|||
|
|
### Parameters
|
|||
|
|
|
|||
|
|
|
|||
|
|
Name | Type | Description | Required | Notes
|
|||
|
|
------------- | ------------- | ------------- | ------------- | -------------
|
|||
|
|
**api_key** | **String** | The api key. | [required] |
|
|||
|
|
**basic_data** | Option<[**MasspaymentPacksFields**](MasspaymentPacksFields.md)> | Transaction data. | |
|
|||
|
|
|
|||
|
|
### Return type
|
|||
|
|
|
|||
|
|
[**crate::models::MasspaymentPacksResponse**](masspayment_packs_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_masspayment_transfers_post
|
|||
|
|
|
|||
|
|
> crate::models::MasspaymentTransfersResponse api_gw_api_key_masspayment_transfers_post(api_key, basic_data)
|
|||
|
|
transfers
|
|||
|
|
|
|||
|
|
This method allows browsing through transfers within one package. Required parameters (besides those described in mass payments main description), at least 1 is obligatory. If any records exist, there will be transfer objects in transfers section representing several transfers.
|
|||
|
|
|
|||
|
|
### Parameters
|
|||
|
|
|
|||
|
|
|
|||
|
|
Name | Type | Description | Required | Notes
|
|||
|
|
------------- | ------------- | ------------- | ------------- | -------------
|
|||
|
|
**api_key** | **String** | The api key. | [required] |
|
|||
|
|
**basic_data** | Option<[**MasspaymentTransfersFields**](MasspaymentTransfersFields.md)> | Transaction data. | |
|
|||
|
|
|
|||
|
|
### Return type
|
|||
|
|
|
|||
|
|
[**crate::models::MasspaymentTransfersResponse**](masspayment_transfers_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)
|
|||
|
|
|