v1

latestOpenAPI 3.0.2Apache 2.02026-07-14384753.8 KB

Businesses

Update Business Payment Settings

put/businesses/{business_id}/settings/payments

Path parameters

business_idstring required

Request body

paymentOnlineEnabledboolean

Allow customers to pay online

paymentMethodsobject

Payment methods that are enabled for this business. The key is the payment method name and the value is a boolean indicating whether the payment method is enabled or not. The payment method names are eg: 'cash', 'check', 'credit_card', 'bank_transfer', 'other'

paymentProvidersobject

Payment providers that are enabled for this business. The key is the payment provider name and the value is the payment provider ID, indicating whether the payment provider is enabled or not. The payment provider names are eg: 'stripe', 'paypal', 'square', 'other'

defaultPaymentMethodstring

The default payment method for this business

defaultPaymentProviderstring

The default payment provider for this business

defaultPaymentTermsstring

Response

Successful Response

{"stackTrail":"paths:/businesses/{business_id}/settings/payments:put:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}