Skip to main content
GET
Get Charge Timeline

Headers

TENANT
string
required

The tenant you are making this request on behalf of

API-KEY
string
required

Your api key

Query Parameters

charge_id
string | null
payment_id
string | null

Response

Successful Response

id
string
required
type
enum<string>
required
Available options:
CHARGE,
PAYMENT,
REFUND,
VOID,
ADJUSTMENT,
EXTERNAL_SETTLEMENT,
WRITE_OFF,
SCHEDULED_PAYMENT,
FAILED_PAYMENT
amount
integer
required
date
string<date-time>
required
paymentMethod
PaymentMethodSummary · object | null
paymentMedium
string | null
status
Available options:
OUTSTANDING,
PAID,
EXTERNAL_SETTLEMENT,
VOID,
WRITE_OFF,
REFUNDED,
CHARGEBACK,
PAYMENT_PLAN,
COLLECTIONS
comment
string | null
description
string | null
refundReason
string | null
items
ChargeItemDetail · object[] | null
discountAmount
integer | null
creator
UserTiny · object | null
feeToPatient
integer | null
tips
TipDetail · object[] | null