# openapi.api.PaymentsApi

## Load the API package
```dart
import 'package:openapi/api.dart';
```

All URIs are relative to *http://localhost*

Method | HTTP request | Description
------------- | ------------- | -------------
[**cancelProviders**](PaymentsApi.md#cancelproviders) | **POST** /api/provider/payments/cancel | 
[**changeProviderStatus**](PaymentsApi.md#changeproviderstatus) | **POST** /api/provider/payments/change-provider-status | 
[**connectPayPal**](PaymentsApi.md#connectpaypal) | **POST** /api/provider/payments/paypal/connect-account | 
[**connectPaypalAccount**](PaymentsApi.md#connectpaypalaccount) | **POST** /api/provider/payments/paypal/connect | 
[**connectStripeAccount**](PaymentsApi.md#connectstripeaccount) | **POST** /api/provider/payments/stripe/connect-account | 
[**createCustomProvider**](PaymentsApi.md#createcustomprovider) | **POST** /api/provider/payments/custom/create-provider | 
[**createRefund**](PaymentsApi.md#createrefund) | **POST** /api/provider/payments/create-stripe-refund | 
[**createStripeAccount**](PaymentsApi.md#createstripeaccount) | **POST** /api/provider/payments/stripe/create-account | 
[**createStripePaymentIntentMessage**](PaymentsApi.md#createstripepaymentintentmessage) | **POST** /api/provider/payments/create_stripe_payment_intent | 
[**getAccountStatus**](PaymentsApi.md#getaccountstatus) | **POST** /api/provider/payments/stripe/create-payment-intent | 
[**getAllProviders**](PaymentsApi.md#getallproviders) | **GET** /api/provider/payments/get-all-providers | 
[**getProvider**](PaymentsApi.md#getprovider) | **POST** /api/provider/payments/get-provider | 
[**getProviders**](PaymentsApi.md#getproviders) | **GET** /api/provider | 
[**updateCustomProvider**](PaymentsApi.md#updatecustomprovider) | **POST** /api/provider/payments/custom/update-provider/{id} | 


# **cancelProviders**
> String cancelProviders(cancelDto)



### Example
```dart
import 'package:openapi/api.dart';

final api = Openapi().getPaymentsApi();
final CancelDto cancelDto = ; // CancelDto | 

try {
    final response = api.cancelProviders(cancelDto);
    print(response);
} catch on DioError (e) {
    print('Exception when calling PaymentsApi->cancelProviders: $e\n');
}
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **cancelDto** | [**CancelDto**](CancelDto.md)|  | 

### Return type

**String**

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

[[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)

# **changeProviderStatus**
> OkRes changeProviderStatus(changeProviderStatusBody)



### Example
```dart
import 'package:openapi/api.dart';

final api = Openapi().getPaymentsApi();
final ChangeProviderStatusBody changeProviderStatusBody = ; // ChangeProviderStatusBody | 

try {
    final response = api.changeProviderStatus(changeProviderStatusBody);
    print(response);
} catch on DioError (e) {
    print('Exception when calling PaymentsApi->changeProviderStatus: $e\n');
}
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **changeProviderStatusBody** | [**ChangeProviderStatusBody**](ChangeProviderStatusBody.md)|  | 

### Return type

[**OkRes**](OkRes.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

[[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)

# **connectPayPal**
> String connectPayPal(connectPaypal)



### Example
```dart
import 'package:openapi/api.dart';

final api = Openapi().getPaymentsApi();
final ConnectPaypal connectPaypal = ; // ConnectPaypal | 

try {
    final response = api.connectPayPal(connectPaypal);
    print(response);
} catch on DioError (e) {
    print('Exception when calling PaymentsApi->connectPayPal: $e\n');
}
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **connectPaypal** | [**ConnectPaypal**](ConnectPaypal.md)|  | 

### Return type

**String**

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

[[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)

# **connectPaypalAccount**
> String connectPaypalAccount()



### Example
```dart
import 'package:openapi/api.dart';

final api = Openapi().getPaymentsApi();

try {
    final response = api.connectPaypalAccount();
    print(response);
} catch on DioError (e) {
    print('Exception when calling PaymentsApi->connectPaypalAccount: $e\n');
}
```

### Parameters
This endpoint does not need any parameter.

### Return type

**String**

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

[[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)

# **connectStripeAccount**
> ConnectStripeRes connectStripeAccount()



### Example
```dart
import 'package:openapi/api.dart';

final api = Openapi().getPaymentsApi();

try {
    final response = api.connectStripeAccount();
    print(response);
} catch on DioError (e) {
    print('Exception when calling PaymentsApi->connectStripeAccount: $e\n');
}
```

### Parameters
This endpoint does not need any parameter.

### Return type

[**ConnectStripeRes**](ConnectStripeRes.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

[[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)

# **createCustomProvider**
> OkRes createCustomProvider(createCustomProvider)



### Example
```dart
import 'package:openapi/api.dart';

final api = Openapi().getPaymentsApi();
final CreateCustomProvider createCustomProvider = ; // CreateCustomProvider | 

try {
    final response = api.createCustomProvider(createCustomProvider);
    print(response);
} catch on DioError (e) {
    print('Exception when calling PaymentsApi->createCustomProvider: $e\n');
}
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **createCustomProvider** | [**CreateCustomProvider**](CreateCustomProvider.md)|  | 

### Return type

[**OkRes**](OkRes.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

[[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)

# **createRefund**
> String createRefund(refundStripePaymentDto)



### Example
```dart
import 'package:openapi/api.dart';

final api = Openapi().getPaymentsApi();
final RefundStripePaymentDto refundStripePaymentDto = ; // RefundStripePaymentDto | 

try {
    final response = api.createRefund(refundStripePaymentDto);
    print(response);
} catch on DioError (e) {
    print('Exception when calling PaymentsApi->createRefund: $e\n');
}
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **refundStripePaymentDto** | [**RefundStripePaymentDto**](RefundStripePaymentDto.md)|  | 

### Return type

**String**

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

[[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)

# **createStripeAccount**
> String createStripeAccount()



### Example
```dart
import 'package:openapi/api.dart';

final api = Openapi().getPaymentsApi();

try {
    final response = api.createStripeAccount();
    print(response);
} catch on DioError (e) {
    print('Exception when calling PaymentsApi->createStripeAccount: $e\n');
}
```

### Parameters
This endpoint does not need any parameter.

### Return type

**String**

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

[[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)

# **createStripePaymentIntentMessage**
> createStripePaymentIntentMessage(body)



### Example
```dart
import 'package:openapi/api.dart';

final api = Openapi().getPaymentsApi();
final JsonObject body = Object; // JsonObject | 

try {
    api.createStripePaymentIntentMessage(body);
} catch on DioError (e) {
    print('Exception when calling PaymentsApi->createStripePaymentIntentMessage: $e\n');
}
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **body** | **JsonObject**|  | 

### Return type

void (empty response body)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: Not defined

[[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)

# **getAccountStatus**
> getAccountStatus()



### Example
```dart
import 'package:openapi/api.dart';

final api = Openapi().getPaymentsApi();

try {
    api.getAccountStatus();
} catch on DioError (e) {
    print('Exception when calling PaymentsApi->getAccountStatus: $e\n');
}
```

### Parameters
This endpoint does not need any parameter.

### Return type

void (empty response body)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: Not defined

[[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)

# **getAllProviders**
> GetAllProvidersRes getAllProviders()



### Example
```dart
import 'package:openapi/api.dart';

final api = Openapi().getPaymentsApi();

try {
    final response = api.getAllProviders();
    print(response);
} catch on DioError (e) {
    print('Exception when calling PaymentsApi->getAllProviders: $e\n');
}
```

### Parameters
This endpoint does not need any parameter.

### Return type

[**GetAllProvidersRes**](GetAllProvidersRes.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

[[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)

# **getProvider**
> GetProviderRes getProvider(getProviderBody)



### Example
```dart
import 'package:openapi/api.dart';

final api = Openapi().getPaymentsApi();
final GetProviderBody getProviderBody = ; // GetProviderBody | 

try {
    final response = api.getProvider(getProviderBody);
    print(response);
} catch on DioError (e) {
    print('Exception when calling PaymentsApi->getProvider: $e\n');
}
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **getProviderBody** | [**GetProviderBody**](GetProviderBody.md)|  | 

### Return type

[**GetProviderRes**](GetProviderRes.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

[[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)

# **getProviders**
> BuiltList<Provider> getProviders()



### Example
```dart
import 'package:openapi/api.dart';

final api = Openapi().getPaymentsApi();

try {
    final response = api.getProviders();
    print(response);
} catch on DioError (e) {
    print('Exception when calling PaymentsApi->getProviders: $e\n');
}
```

### Parameters
This endpoint does not need any parameter.

### Return type

[**BuiltList&lt;Provider&gt;**](Provider.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

[[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)

# **updateCustomProvider**
> OkRes updateCustomProvider(id, updateCustomProvider)



### Example
```dart
import 'package:openapi/api.dart';

final api = Openapi().getPaymentsApi();
final num id = 8.14; // num | 
final UpdateCustomProvider updateCustomProvider = ; // UpdateCustomProvider | 

try {
    final response = api.updateCustomProvider(id, updateCustomProvider);
    print(response);
} catch on DioError (e) {
    print('Exception when calling PaymentsApi->updateCustomProvider: $e\n');
}
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **id** | **num**|  | 
 **updateCustomProvider** | [**UpdateCustomProvider**](UpdateCustomProvider.md)|  | 

### Return type

[**OkRes**](OkRes.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

[[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)