EflClient
startProcess
Starts a new leasing process and returns the initial redirect URL or process identifier.
startProcess() initialises a leasing process for a given partner and return URLs.
It wraps the low-level ProcessApiClient::init() endpoint.
All methods on EflClient may throw:
ApiException– when the EFL API returns an error response.HttpException– when the HTTP transport fails.
Method signature
public function startProcess(
?string $positiveUrlResponse,
?string $negativeUrlResponse,
string $bearerToken
): string
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
positiveUrlResponse | string|null | No | URL used when the process succeeds; may be null. |
negativeUrlResponse | string|null | No | URL used when the process fails or is cancelled; may be null. |
bearerToken | string | Yes | Bearer token obtained via getAuthToken. |
Return value
- Type:
string– raw response body, typically containing a redirect URL or process identifier.