POST
/v1/definitions/{key}/rows/{rowId}/plaid/items/{itemId}/check-paymentCheck an expected bank payment
Compare posted transactions against dynamic expectedAmountMinor, dueAt (RFC3339), graceHours, currency, query and direction. Returns matched, not_due, not_observed or unknown. A not_observed result is a review signal, not proof of nonpayment. Unknown or stale data must not trigger a demand.
Access class: def:read.
Send request
Use the documented inputs to call this endpoint directly.
API serverbase URL
Bearer tokensessionoptional
Stored only in this browser for the session security scheme and reused on every API page in this group.
Parameters
Values are applied to the request and the example on the right.
keypath · stringrequired
rowIdpath · stringrequired
itemIdpath · stringrequired
Request body
application/jsonrequiredaccountIdstringoptional
currencystringoptional
directionstringoptional
dueAtstringoptional
expectedAmountMinornumberoptional
fromstringoptional
graceHoursnumberoptional
includePendingbooleanoptional
limitintegeroptional
lookbackDaysnumberoptional
maxAgeHoursnumberoptional
querystringoptional
tostringoptional
Responses
201application/json
the action's answer
{
"data": {
"bank": {
"accounting": true,
"connectionStatus": "string",
"currency": "string",
"from": "string",
"hasNegativeBalance": true,
"itemId": "",
"lastSyncedAt": "2026-01-01T00:00:00Z",
"matchedCount": 1,
"negativeBalances": [
"string"
],
"syncPending": true,
"to": "string",
"totalAmountMinor": 1,
"transactions": [
"string"
],
"truncated": true
},
"expectedAmountMinor": 1,
"reason": "string",
"status": "string"
}
}dataoptional
defaultapplication/json
a refusal: {"error": "<what a person needs to read>"}. 401 no credential, 402 the plan does not include this, 403 the seat does not, 404 the thing does not exist or is not yours to see.
{
"error": "string"
}errorstringrequired