Skip to content
Booking Engine API Docs

/v1/bookings/{reservationId}/refunds

POST
/v1/bookings/{reservationId}/refunds
curl --request POST \
  --url http://localhost:8787/v1/bookings/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/refunds \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "amountMinorUnits": "example" }'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
reservationId
required
string format: uuid

Request Body

Section titled “Request Body”
Media typeapplication/json
object
amountMinorUnits
string
/^\d+$/
Examplegenerated
{
  "amountMinorUnits": "example"
}

Responses

Section titled “Responses”

200

Section titled “200”

The refund, succeeded.

Media typeapplication/json
object
amountMinorUnits
required
string
/^\d+$/
currency
required
string
>= 3 characters <= 3 characters
id
required
string format: uuid
reservationId
required
string format: uuid
state
required
string
Allowed values: pending succeeded failed
stripeRefundId
required
string | null
Example
{
  "state": "pending"
}

404

Section titled “404”

No such booking for this tenant.

Media typeapplication/problem+json
object
code
required
string
Allowed values: booking_not_found no_succeeded_payment stripe_not_configured refund_exceeds_payment stripe_refund_failed nothing_to_refund
detail
required
string
status
required
number
title
required
string
type
required
string
Example
{
  "code": "booking_not_found"
}

409

Section titled “409”

No succeeded payment to refund, no Stripe Connect account, the requested amount exceeds what was paid, the requested amount is zero (or nothing remains to refund), or Stripe refused the refund.

Media typeapplication/problem+json
object
code
required
string
Allowed values: booking_not_found no_succeeded_payment stripe_not_configured refund_exceeds_payment stripe_refund_failed nothing_to_refund
detail
required
string
status
required
number
title
required
string
type
required
string
Example
{
  "code": "booking_not_found"
}