API Reference
GraphQL Explorer

Refund a tab payment

post
https://gotab.io/api/loc//tabs//refund

Issues a partial refund against a single payment on the tab. Provide either an amount (in cents) for an open refund, or a list of items for an itemized refund, but not both.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
  • The unique identifier of the location
string
required
  • The unique identifier of the tab
Body Params
string
  • The payment to refund. Optional when the tab has exactly one refundable payment.
integer
  • The amount to refund in cents. Mutually exclusive with items.
items
array
  • The items to refund. Each entry requires an itemId and a positive integer quantity, with an optional reason. Mutually exclusive with amount.
items
string
  • The reason for the refund. Defaults to "Refund".
Response
200

Successful response

Updated about 2 months ago

Did this page help you?
Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here!

Updated about 2 months ago

Did this page help you?