Actions37
- API Key Info Actions
- Claim Actions
- Claim Document Actions
- Debtor Actions
- Mandate Actions
- Order Actions
- Payment Actions
- Single Mandate Statement Actions
- Statement Actions
Mandate → Get
AI-generatedSummary
Retrieve detailed information about a specific mandate using its Mandate ID, optionally including its published status update history.
Inputs
- Mandate ID (required) — The unique identifier of the mandate (case) created by Paywise upon order acceptance.
- Include History — Boolean flag to include the published status updates in the mandate information returned.
Output shape
A single record representing the mandate details, optionally containing an array of its status update history if requested.
If 'Include History' is set to true, the response includes the mandate's published status updates. Otherwise, these are omitted.
Examples
Example 1: Get mandate basic details
Mandate ID set to the target mandate's identifier, Include History left false or omitted.
Example 2: Get mandate details with status updates
Mandate ID set, Include History set to true to receive the mandate's status update history.