Skip to main content
GET
Get source freshness

Authorizations

Authorization
string
header
required

Integration-owned environment-specific API key. Never paste a production key into documentation tools.

Path Parameters

clientCode
string
required

Stable non-sensitive Client code authorized by the Integration grant.

Pattern: ^[A-Za-z0-9_-]{1,128}$

Response

Current freshness of this connection's source evidence.

Freshness of this connection's accepted source evidence at evaluation time. Fresh evidence clears only the freshness hold; it never clears Disputes, source restrictions or other protections.

state
enum<string>
required

not_configured means this connection has no approved freshness limit, so no freshness hold applies.

Available options:
not_configured,
fresh,
stale
limitSeconds
integer | null
required

Approved maximum age of the latest accepted source evidence, derived from this connection's agreed delivery cadence.

Required range: 60 <= x <= 2678400
basis
string | null
required

The approved business meaning of the limit, for example the agreed cadence plus tolerance.

Required string length: 1 - 200
lastEvidenceAt
string<date-time> | null
required

When PayPathIQ last committed an accepted source write from this connection.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
staleAt
string<date-time> | null
required

When the latest evidence exceeds the limit; null when no evidence has been accepted or no limit is configured.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
evaluatedAt
string<date-time>
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
recoveryHeld
boolean
required

True while recovery actions for this connection's Receivables are held.

paymentInitiationHeld
boolean
required

True while new payment initiation for this connection's Receivables is held. Confirmed provider results, source updates and reconciliation evidence are still accepted.

heldReason
string | null
required
Allowed value: "source_stale"