Read a barber's payout preferences

GET

barbers

{id}

preferences

payouts

Read a barber's payout preferences

curl --request GET \
  --url https://api.guile.app/barbers/{id}/preferences/payouts \
  --header 'Authorization: Bearer <token>'

{
  "settings": {
    "frequency": "weekly",
    "dayOfWeek": "monday"
  }
}

Path Parameters

string<uuid>

required

The unique, opaque system identifier for a resource. This case-sensitive ID is also used as path parameters in URLs or in other properties or parameters that reference a resource by ID rather than URL.

Response

Ok. The operation succeeded.

Properties for the configuration of payouts from the payment processor. Payouts scheduled on weekends or holidays are processed on the next available business day.

settings

object

required

The settings for payout preferences by frequency.

Option 1
Option 2
Option 3
Option 4

Show child attributes

settings.frequency

enum<string>

required

Identifier for the payout frequency.

Available options:

weekly

settings.dayOfWeek

enum<string>

required

The day of the week for weekly payment processing. For weekend days, processing is performed the following business day. The following business day is either Monday or Tuesday (if Monday is a holiday.)

Available options:

monday,

tuesday,

wednesday,

thursday,

friday,

saturday,

sunday

Configure a barber's payout preferencesUpdate a barber's payout preferences. Only the barber assigned to this profile or a system administrator can apply the changes.

⌘I

Read a barber's payout preferences

curl --request GET \
  --url https://api.guile.app/barbers/{id}/preferences/payouts \
  --header 'Authorization: Bearer <token>'

{
  "settings": {
    "frequency": "weekly",
    "dayOfWeek": "monday"
  }
}

Public APIs

API Concepts

Authentication

Appointments

Barbers

Businesses

Clients

Customers

Fees

Integrations

Invitations

Payouts

Photos

Refunds

Services

Read a barber's payout preferences

Path Parameters

Response