Refund a cancelled appointment

Refund a booking cancelled earlier without refunding. Only a cancelled appointment; one
still going ahead cannot be refunded here.

Vendor team members and partner staff (naming the vendor in X-Vendor-Code) with the
refund appointment permission only. No API key can refund, whatever its scopes:
a key gets 403 Refunds cannot be made with an API key. Refund from the portal.

Gateway bookings are refunded through their gateway: Paystack and Stripe report
pending until the gateway confirms, then the money is taken back from the vendor
(and its partner and Oyster in proportion); Startbutton checks a refund before it
accepts it, so an accepted one is completed at once. Wallet bookings go back to the
client's wallet at once. A booking the partner collected on its own gateway, and a
cancelled appointment whose payment was carried to a rebooking, are refused.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Body Params
number | null
≥ 0.01

A partial refund in the booking's currency. Omitted, everything left is refunded.

string
required
length ≤ 255
Headers
string

Partner staff only. The slug of the vendor whose appointment this is.

Responses

403

An API key, someone outside the vendor's team or its partner, or no refund appointment permission

404

Appointment not found, or X-Vendor-Code names no vendor of yours (OYS-PARTNER-1001)

422

Not cancelled, rebooked, partner-collected, more than is left, the vendor cannot cover it, or the gateway refused (its message, verbatim)

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json