Skip to main content
POST
/
refunds
Request a refund
curl --request POST \
  --url https://api.guile.app/refunds \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "appointmentId": "<string>",
  "amount": "456.78",
  "reason": "<string>"
}
'
{
  "id": "<string>",
  "appointmentId": "<string>",
  "requestedAmount": "456.78",
  "reason": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "approvedAmount": "456.78",
  "responseNote": "<string>",
  "refundPaymentId": "<string>"
}

Body

application/json

Request body for requesting a refund.

​
appointmentId
string
required

The appointment to request a refund for.

​
amount
string<decimal>
required

The amount requested for refund.

Pattern: ^-?(0|[1-9][0-9]*)\.[0-9][0-9]$
Example:

"456.78"

​
reason
string
required

Reason for requesting the refund.

Maximum string length: 500

Response

Ok. The operation succeeded.

Represents a refund request from a customer.

​
id
string
required

Unique identifier for the refund request.

​
appointmentId
string
required

The appointment this refund request is for.

​
requestedAmount
string<decimal>
required

The amount requested for refund.

Pattern: ^-?(0|[1-9][0-9]*)\.[0-9][0-9]$
Example:

"456.78"

​
reason
string
required

Customer's reason for requesting the refund.

Maximum string length: 500
​
state
enum<string>
required

The state of the refund request.

Available options:
pending,
approved,
denied,
processed
​
createdAt
string<date-time>
required

The date-time when this resource was created, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. This is derived and immutable.

​
updatedAt
string<date-time>
required

The date-time when this resource was updated, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. This is derived and immutable.

​
approvedAmount
string<decimal>

The amount approved for refund, if approved.

Pattern: ^-?(0|[1-9][0-9]*)\.[0-9][0-9]$
Example:

"456.78"

​
responseNote
string

Note from the approver/denier, if provided.

Maximum string length: 500
​
refundPaymentId
string

If approved and processed, the ID of the resulting refund payment.