Skip to main content
GET
List mandate correspondence

Authorizations

Authorization
string
header
required

Company-bound Case Management API key — the standard credential for this API.

Headers

X-On-Behalf-Of-Company
string<uuid>

Required when a Partner key calls the Case Management API; rejected for direct Case keys. Contains the entitled paywise company UUID.

Path Parameters

mandate_id
string<uuid>
required

UUID of the parent accepted case in this request.

Query Parameters

channel
string

Only this channel. Unknown channels yield an empty page.

cursor
string

Opaque continuation cursor for incremental synchronization, taken from the next URL of a previous page. Only valid together with updated_since: with updated_since set the list is ordered by change time and then id and pages by this cursor instead of offset, so a row that changes while you page is returned again later instead of pushing another row out of the result. Rows changed less than 60 seconds ago are held back until they are settled; use the largest updated_at you received as the next updated_since.

direction
enum<string>

Only inbound (received from the debtor) or outbound (sent by paywise) items.

Available options:
inbound,
outbound
limit
integer
default:10

Number of results to return (maximum 100).

Required range: 1 <= x <= 100
offset
integer
default:0

Zero-based result offset.

Required range: x >= 0
updated_since
string<date-time>

Return entries changed at or after this timezone-aware RFC 3339 timestamp (inclusive). With it set, results are ordered by change time and then id instead of newest first, page by cursor instead of offset, and entries changed less than a minute ago are held back.

Response

count
integer
required

Total number of matching resources.

Example:

123

results
object[]
required

Resources returned for the requested page.

next
string<uri> | null

URL for the next page, or null when this is the last page. With updated_since it carries an opaque cursor.

Example:

"http://api.example.org/accounts/?offset=400&limit=100"

previous
string<uri> | null

URL for the previous page, or null when this is the first page. Always null with updated_since.

Example:

"http://api.example.org/accounts/?offset=200&limit=100"