Skip to main content
GET
Get Refund Context

Headers

TENANT
string
required

The tenant you are making this request on behalf of

API-KEY
string
required

Your api key

Path Parameters

payment_id
string
required

Response

Successful Response

paymentId
string
required
paymentAmount
integer
required
feeToPatient
integer
required
refundableAmount
integer
required
status
enum<string>
required

Status of a Payment or Refund.

NOTE for any "cash collected / refunded" or settlement-style query: both SUCCEEDED AND PROCESSING count as money committed. SUCCEEDED means cleared in the bank account; PROCESSING means the transaction is in flight (e.g. ACH still settling) but the clinic should expect it. Most accounting / analytics aggregates that filter only on status == SUCCEEDED silently undercount real cash flow — use status IN (SUCCEEDED, PROCESSING) unless you specifically want only fully-cleared funds.

Use COMMITTED_PAYMENT_STATUSES below for the common case.

Available options:
CANCELED,
CREATED,
FAILED,
IN_REVIEW,
PRESENTING,
PROCESSING,
SUCCEEDED
paymentMedium
string
required
charges
RefundableCharge · object[]