Record a refund of an order

Records money already returned to the guest outside this app (cash, card terminal, a till's own tenders); no payment provider is called, and imported orders are refused for Fortis to record. A guest's online MyFatoorah payment is never recorded here: it is refunded through payments.refundMyFatoorah. Refused with BAD_REQUEST and refusal refundThroughMyFatoorah when such a payment still has money to refund and the request names no amount, asks for more than the order's other payments hold, or sends an expectedRemainingCents that counts that payment. Each refunded payment's tip goes back with it, in the share of that payment refunded, posted as negative tip rows; the refunds that empty a payment return exactly the tip paid on it.

post/api/public/v1/payments/refund

Request

  • Base URL: https://app.fortuneos.ai
  • URL: https://app.fortuneos.ai/api/public/v1/payments/refund
  • Auth: none declared

Request body

idstring required
amountCentsinteger
paymentType'cash' | 'card' | 'voucher' | 'gift_card' | 'staff' | 'bank_transfer' | 'payment_link' | 'zomato_pay' | 'careem_pay' | 'myfatoorah'
lineIdsstring[]
reasonstring
idempotencyKeystring
expectedRemainingCentsinteger

Response

OK

unknown required

Changes

No recorded changes to this operation across all 1 revision of this API.