Skip to main content
POST
Record an inbound check

Authorizations

x-api-key
string
header
required

Org-issued integration API key (service account credential). The plaintext secret is shown once at creation.

Headers

X-Idempotency-Key
string
required

Stable caller-chosen key (max 200 chars) making the mutation safely retryable.

Maximum string length: 200

Path Parameters

caseId
string
required

Case id

Body

application/json
amountCents
integer
required
Required range: 0 <= x <= 100000000000
checkType
enum<string>
required
Available options:
settlement_proceeds,
medical_reimbursement,
lien_payment,
expense_reimbursement,
attorney_fee_payment,
third_party_payment,
client_reimbursement,
insurance_refund,
recurring_wage_loss,
direct_to_client,
other
dateReceived
string
required
depositDate
string
checkNumber
string
Required string length: 1 - 100
payorContactId
string
Required string length: 1 - 200
payorName
string
Required string length: 1 - 500
resolutionId
string
Required string length: 1 - 200
deliveryMethod
enum<string>
Available options:
wire,
print,
ach,
other
notes
string
Maximum string length: 10000

Response

{ success: true, check }

success
boolean
required
{key}
any