Skip to main content
GET
/
appointments
/
{appointmentId}
/
payments
List appointment payments
curl --request GET \
  --url https://api.guile.app/appointments/{appointmentId}/payments \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "paymentMethod": "platform",
      "paymentDirection": "payment",
      "paymentState": "pending",
      "amount": "456.78",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "paymentToken": "<string>",
      "externalId": "<string>",
      "originalPaymentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "refundReason": "<string>"
    }
  ],
  "count": 1
}

Path Parameters

​
appointmentId
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.

Query Parameters

​
paymentMethod
enum<string>[]

When included, filter to payments with any of these payment methods. When excluded, payments are not filtered by payment method.

The method used to process the payment.

platform means Guile manages the payment through our payment provider.

external means the payment is managed externally. This is either cash or a peer-to-peer payment system, such as Venmo.

Available options:
platform,
external
​
paymentDirection
enum<string>[]

When included, filter to payments with any of these payment directions. When excluded, payments are not filtered by payment direction.

The direction of the payment flow.

payment means money flows from customer to business. refund means money flows from business to customer.

Available options:
payment,
refund
​
paymentState
enum<string>[]

When included, filter to payments with any of these payment states. When excluded, payments are not filtered by payment state.

Valid payment states of the appointment.

Available options:
pending,
authorized,
paid,
failed

Response

Ok. The operation succeeded.

A list response for resources. This response contains the full result set after any filters are applied.

​
items
object[]
required
​
count
integer<int16>
required
Required range: x >= 0