# Vend\PaymentTypesApi



All URIs are relative to https://example.retail.lightspeed.app/api/2026-07, except if the operation defines another base path.

| Method | HTTP request | Description |
| ------------- | ------------- | ------------- |
| [**listPaymentTypes()**](PaymentTypesApi.md#listPaymentTypes) | **GET** /payment_types | List payment types |


## `listPaymentTypes()`

```php
listPaymentTypes($after, $before, $page_size, $deleted, $outlet_id, $currency, $only_lspay): \Vend\Model\PaymentTypeCollection
```

List payment types

Returns a paginated collection of payment types.  🔒 Requires: `payment_types:read` scope

### Example

```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure Bearer (JWT) authorization: bearerAuth
$config = Vend\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Vend\Api\PaymentTypesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$after = 56; // int | The lower limit for the version numbers to be included in the response.
$before = 56; // int | The upper limit for the version numbers to be included in the response.
$page_size = 56; // int | The maximum number of items to be returned in the response.
$deleted = True; // bool | If true, includes deleted payment types in the response.
$outlet_id = 'outlet_id_example'; // string | Filters payment types by outlet. Only effective when the payment_type_controls feature is enabled.
$currency = 'currency_example'; // string | Filters payment types by currency code (ISO 4217, e.g. \"AUD\", \"USD\").
$only_lspay = True; // bool | If true, returns only LSPay payment types.

try {
    $result = $apiInstance->listPaymentTypes($after, $before, $page_size, $deleted, $outlet_id, $currency, $only_lspay);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PaymentTypesApi->listPaymentTypes: ', $e->getMessage(), PHP_EOL;
}
```

### Parameters

| Name | Type | Description  | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **after** | **int**| The lower limit for the version numbers to be included in the response. | [optional] |
| **before** | **int**| The upper limit for the version numbers to be included in the response. | [optional] |
| **page_size** | **int**| The maximum number of items to be returned in the response. | [optional] |
| **deleted** | **bool**| If true, includes deleted payment types in the response. | [optional] |
| **outlet_id** | **string**| Filters payment types by outlet. Only effective when the payment_type_controls feature is enabled. | [optional] |
| **currency** | **string**| Filters payment types by currency code (ISO 4217, e.g. \&quot;AUD\&quot;, \&quot;USD\&quot;). | [optional] |
| **only_lspay** | **bool**| If true, returns only LSPay payment types. | [optional] |

### Return type

[**\Vend\Model\PaymentTypeCollection**](../Model/PaymentTypeCollection.md)

### Authorization

[bearerAuth](../../README.md#bearerAuth)

### HTTP request headers

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

[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)
