Skip to main content
POST
Refund Payment

Headers

TENANT
string
required

The tenant you are making this request on behalf of

API-KEY
string
required

Your api key

Body

application/json

Create a refund for a payment.

paymentId
string
required
providerId
string
required
amount
integer
required
reason
enum<string>
required
Available options:
DUPLICATE,
DISPUTE,
BOOKING_FEE,
OTHER
description
string | null
locationId
string | null
restoreInventory
boolean
default:false

Response

Successful Response

id
string
required
paymentId
string
required
amount
integer
required
reason
enum<string>
required
Available options:
DUPLICATE,
DISPUTE,
BOOKING_FEE,
OTHER
createdDate
string<date-time>
required
status
enum<string>
required
Available options:
CANCELED,
CREATED,
FAILED,
IN_REVIEW,
PRESENTING,
PROCESSING,
SUCCEEDED
rainforestRefundId
string | null
fee
integer
default:0