Retrieve the list of payment methods

GET https://api.zenoti.com/Catalog/Payments/ProcessorSettings

This API helps you to retrieve the list of payment methods that have been configured at the specified center.

You must specify appropriate details for the parameters in the API request. For more information, refer to the Request Parameters table.

Before you begin

Permission: Manage API Keys (on the Administrator security object) — Required to access Zenoti APIs.

Endpoint

GET /Catalog/Payments/ProcessorSettings

Base URL: https://api.zenoti.com

Request

Headers

Header Required Description
Authorization Yes bearer {{access_token}}

Query parameters

Parameter Type Required Default Description
CenterId string Yes — Mandatory Unique 32-character identifier of the center.
Source enum () No — Optional Indicates the source of the class booking: Web - 0, WebStore - 1, CheckWeb - 2, CheckWebStore - 3, Dunning - 4, Mobile - 5, MobilePOS - 6, All - 7.

Response

Success (200 OK)

{
  "GatewaySettings": {
    "Account": "107110565",
    "user_email": "kirityg@zenoti.com",
    "AccountName": "KQA",
    "AccountHolderCode": "e9e1eb76-e315-450b-b0ee-750e969062b3",
    "MerchantAccount": "ZenotiUSA",
    "ApplicationFeePercent": "3.50",
    "ApplicationFeePercentInPerson": "2.40",
    "TransactionFee": "30",
    "TransactionFeeInPerson": "30",
    "ApplicationFeePercentAMEX": "2.90",
    "ApplicationFeePercentInPersonAMEX": "2.90",
    "TransactionFeeAMEX": "30",
    "TransactionFeeInPersonAMEX": "30",
    "ProcessDisputes": "true",
    "StatementDescriptor": "KQA",
    "ProcessorId": "Adyen",
    "EnableAVS": "False"
  },
  "Error": {}
}

Response fields

Field Type Description
GatewaySettings object
GatewaySettings.Account string
GatewaySettings.user_email string
GatewaySettings.AccountName string
GatewaySettings.AccountHolderCode string
GatewaySettings.MerchantAccount string
GatewaySettings.ApplicationFeePercent string
GatewaySettings.ApplicationFeePercentInPerson string
GatewaySettings.TransactionFee string
GatewaySettings.TransactionFeeInPerson string
GatewaySettings.ApplicationFeePercentAMEX string
GatewaySettings.ApplicationFeePercentInPersonAMEX string
GatewaySettings.TransactionFeeAMEX string
GatewaySettings.TransactionFeeInPersonAMEX string
GatewaySettings.ProcessDisputes string
GatewaySettings.StatementDescriptor string
GatewaySettings.ProcessorId string
GatewaySettings.EnableAVS string
Error object

Example

curl --request GET \
  --url 'https://api.zenoti.com/Catalog/Payments/ProcessorSettings?CenterId={{CenterId}}' \
  --header 'Authorization: bearer {{access_token}}'
const response = await fetch('https://api.zenoti.com/Catalog/Payments/ProcessorSettings', {
  method: 'GET',
  headers: {
    'Authorization': 'bearer {{access_token}}'
  },
});
const data = await response.json();
import requests

response = requests.get(
    'https://api.zenoti.com/Catalog/Payments/ProcessorSettings',
    headers={
        'Authorization': 'bearer {{access_token}}',
    },
)
data = response.json()
using var client = new HttpClient();
client.DefaultRequestHeaders.Add("Authorization", "bearer {{access_token}}");
var response = await client.GetAsync(
    "https://api.zenoti.com/Catalog/Payments/ProcessorSettings");
var data = await response.Content.ReadAsStringAsync();
require 'net/http'
require 'json'

uri = URI('https://api.zenoti.com/Catalog/Payments/ProcessorSettings')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Get.new(uri)
request['Authorization'] = 'bearer {{access_token}}'
response = http.request(request)
data = JSON.parse(response.body)

Error codes

Status Description
400 400
401 Unauthorized -- invalid or expired access token
429 Too many requests -- rate limit exceeded