ProcessApiClient
ProcessApiClient provides raw access to /Process endpoints in the EFL Leasing Online API.
It is a final class that depends on EflHttpClient, which handles URL building, authentication and HTTP execution.
Class definition
- Namespace:
Imoli\EflLeasingSdk\Api - Implements: none (final utility class)
- Constructor:
- Accepts a single dependency:
EflHttpClient $http. - The same
EflHttpClientinstance is reused for all requests.
- Accepts a single dependency:
In most applications you will use the higher-level EflClient, which internally composes ProcessApiClient.
Methods
init
Low-level wrapper over GET /lon/api/v1/Process/Init.
public function init(
string $bearerToken,
?string $positiveUrlResponse = null,
?string $negativeUrlResponse = null
): HttpResponse
Auth: Bearer token.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
bearerToken | string | Yes | Bearer token (see EflClient::getAuthToken). |
positiveUrlResponse | string|null | No | URL used when the process succeeds; sent as PositiveUrlResponse query parameter. |
negativeUrlResponse | string|null | No | URL used when the process fails or is cancelled; sent as NegativeUrlResponse. |
Return value
- Type:
HttpResponse– raw HTTP response; the body typically contains a redirect URL or process identifier.
getToken
Low-level wrapper over GET /lon/api/v1/Process/GetToken.
public function getToken(string $partnerId): HttpResponse
Auth: ApiKey (configured in Config).
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
partnerId | string | Yes | Partner identifier assigned to you by EFL. |
Return value
- Type:
HttpResponse– body contains the token string used as a Bearer token in subsequent calls.
getChanges
Low-level wrapper over GET /lon/api/v1/Process/GetChanges.
public function getChanges(
string $transactionId,
?array $statusBpm,
string $bearerToken
): HttpResponse
Auth: Bearer token.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
transactionId | string | Yes | Identifier of the transaction whose process changes you want to read. |
statusBpm | string[]|null | No | Optional list of BPM status codes (statusBPM query parameter). |
bearerToken | string | Yes | Bearer token. |
Return value
- Type:
HttpResponse– when used viaEflClient, the body is mapped toFoicProcessStateResponse.
getLastStatus
Low-level wrapper over GET /lon/api/v1/Process/GetLastStatus.
public function getLastStatus(string $transactionId, string $bearerToken): HttpResponse
Auth: Bearer token.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
transactionId | string | Yes | Identifier of the transaction. |
bearerToken | string | Yes | Bearer token. |
Return value
- Type:
HttpResponse– body contains the last status string as returned by the API.
postVerificationCode
Low-level wrapper over POST /lon/api/v1/Process/PostVerificationCode with JSON body built from the model.
public function postVerificationCode(
PostVerificationCode $code,
string $bearerToken
): HttpResponse
Auth: Bearer token.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
code | PostVerificationCode | Yes | Verification code payload to be submitted. |
bearerToken | string | Yes | Bearer token. |
Return value
- Type:
HttpResponse– body contains raw confirmation or error details from the API.
getPostVerificationCodeChanges
Low-level wrapper over GET /lon/api/v1/Process/GetPostVerificationCodeChanges.
public function getPostVerificationCodeChanges(
string $transactionId,
string $bearerToken
): HttpResponse
Auth: Bearer token.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
transactionId | string | Yes | Identifier of the transaction. |
bearerToken | string | Yes | Bearer token. |
Return value
- Type:
HttpResponse– body contains raw information about changes after verification code submission.
getRestoreProcess
Low-level wrapper over GET /lon/api/v1/Process/GetRestoreProcess.
public function getRestoreProcess(string $transactionId): HttpResponse
Auth: none (no Bearer token).
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
transactionId | string | Yes | Identifier of the transaction. |
Return value
- Type:
HttpResponse– body can be mapped toAuthenticateResponse.
getRestoreProcessChanges
Low-level wrapper over GET /lon/api/v1/Process/GetRestoreProcessChanges.
public function getRestoreProcessChanges(string $transactionId): HttpResponse
Auth: none (no Bearer token).
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
transactionId | string | Yes | Identifier of the transaction. |
Return value
- Type:
HttpResponse– body contains raw restore-process change information.
setProcessTypeForCompany
Low-level wrapper over POST /lon/api/v1/Process/SetProcessTypeForCompany.
public function setProcessTypeForCompany(
string $transactionId,
string $bearerToken,
?string $nip = null,
?bool $basketCalculation = null
): HttpResponse
Auth: Bearer token.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
transactionId | string | Yes | Identifier of the transaction. |
bearerToken | string | Yes | Bearer token. |
nip | string|null | No | Optional tax identifier (NIP) for the company. |
basketCalculation | bool|null | No | Whether basket calculation is used; sent as "true" / "false". |
Return value
- Type:
HttpResponse– response does not map to a dedicated model; use status code and body for diagnostics.