Skip to content

Get refund by ID

Request

Retrieve a single refund for the location.

Security
PartnerApiKey and PartnerOAuth
Path
refundIdinteger, (int64)required

Refund ID

Example:1234
accountIdinteger, (int64)required

Account identifier

locationIdinteger, (int64)required

Location identifier

curl -i -X GET \
  'https://api-docs.lobbie.com/_mock/openapi/partner/v2/account/{accountId}/location/{locationId}/refund/1234' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Refund found

Bodyapplication/json
amountobject(Money)

Monetary amount

idinteger, (int64)

Refund ID

Example:1234
invoiceIdinteger, (int64)

Invoice ID

Example:1234
patientIdinteger, (int64)

Patient ID

Example:1234
paymentIdinteger, (int64)

Payment ID

Example:1234
postedOnstring, (date-time)

When the refund was posted (UTC), if known

Example:"2025-01-15T14:00:00Z"
surchargeAmountobject(Money)

Monetary amount

surchargeRatenumber

Surcharge rate (decimal), if any

Example:0.025
Response
{
  "amount": {
    "amount": 50,
    "currency": "USD"
  },
  "id": 1234,
  "invoiceId": 1234,
  "patientId": 1234,
  "paymentId": 1234,
  "postedOn": "2025-01-15T14:00:00Z",
  "surchargeAmount": {
    "amount": 50,
    "currency": "USD"
  },
  "surchargeRate": 0.025
}