Skip to main content
POST
/
billing
/
payment
/
refund
Refund Payment
curl --request POST \
  --url https://api.decodahealth.com/billing/payment/refund \
  --header 'API-KEY: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'TENANT: <tenant>' \
  --data '
{
  "paymentId": "<string>",
  "providerId": "<string>",
  "amount": 123,
  "reason": "DUPLICATE",
  "description": "<string>",
  "locationId": "<string>",
  "restoreInventory": false
}
'
{
  "id": "<string>",
  "paymentId": "<string>",
  "amount": 123,
  "reason": "DUPLICATE",
  "createdDate": "2023-11-07T05:31:56Z",
  "status": "CANCELED",
  "rainforestRefundId": "<string>",
  "fee": 0
}

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