Skip to main content
PATCH
Edit a transaction's details

Authorizations

X-API-Key
string
header
required

Public API key: cxp_<hex> (firm-scoped) or cxpp_<hex> (provider-scoped). Required on every request.

Path Parameters

caseId
string<uuid>
required

Med case UUID: medCaseId in the referral.* webhook payload, or the id from GET /med-cases.

referralId
string<uuid>
required

Med referral UUID: the referral of this case to your pharmacy practice. Find it with GET /med-cases/{id}/referrals, or take it from the referral.* webhook payload.

transactionId
string<uuid>
required

Pharmacy transaction UUID

Body

application/json

Only payer, reference, note and fillId can change. Sending type, amount, transactionDate or reversesTransactionId returns 400 immutable_field (error.details.fields lists them): post a REVERSAL and a new transaction instead.

fillId
string<uuid> | null

Re-link to another fill on this referral, or null to unlink.

payer
string | null
Maximum string length: 300
reference
string | null
Maximum string length: 200
note
string | null
Maximum string length: 2000

Response

Updated transaction

data
object
required

A payment, adjustment, write-off, refund or reversal against the pharmacy's billing. Immutable once recorded except payer, reference, note and fillId: to correct an amount, post a REVERSAL.

meta
object
required