HubTransactionsApiClientInterface
in
Interface HubTransactionsApiClientInterface
Tags
Table of Contents
- getAllowedPaymentModules() : array<string|int, mixed>
- Returns an array of allowed payment modules for the respective client.
- getBeforeTransactionPageContent() : string
- Returns a string containing html or nothing if payment module has no extra page before confirmation.
- getConfirmationContents() : string
- Returns an array of confirmation contents served by the selected payment module.
- getTransactionDetails() : array<string|int, mixed>
- Returns the transaction details.
- startTransaction() : string
- Starts an transaction and returns the transaction code.
Methods
getAllowedPaymentModules()
Returns an array of allowed payment modules for the respective client.
public
getAllowedPaymentModules(CartContent $cartContent, CustomerInformation $customerInformation, HubClientInformation $hubClientInformation, ClientSessionInformation $clientSessionInformation, array<string|int, mixed> $unallowedModuleCodes) : array<string|int, mixed>
Parameters
- $cartContent : CartContent
-
Cart content.
- $customerInformation : CustomerInformation
-
Customer information.
- $hubClientInformation : HubClientInformation
-
Hub client information.
- $clientSessionInformation : ClientSessionInformation
-
Session information.
- $unallowedModuleCodes : array<string|int, mixed>
-
Array of unallowed module codes.
Return values
array<string|int, mixed> —Returns an array with the available modules information.
getBeforeTransactionPageContent()
Returns a string containing html or nothing if payment module has no extra page before confirmation.
public
getBeforeTransactionPageContent(CartContent $cartContent, CustomerInformation $customerInformation, HubClientInformation $hubClientInformation, ClientSessionInformation $clientSessionInformation, array<string|int, mixed> $getData, array<string|int, mixed> $postData, string $moduleCode) : string
Parameters
- $cartContent : CartContent
-
Cart content.
- $customerInformation : CustomerInformation
-
Customer information.
- $hubClientInformation : HubClientInformation
-
Hub client information.
- $clientSessionInformation : ClientSessionInformation
-
Session information.
- $getData : array<string|int, mixed>
-
GET-Request data.
- $postData : array<string|int, mixed>
-
POST-Request data.
- $moduleCode : string
-
Module Code.
Return values
string —Returns a string containing html or nothing.
getConfirmationContents()
Returns an array of confirmation contents served by the selected payment module.
public
getConfirmationContents(CartContent $cartContent, CustomerInformation $customerInformation, HubClientInformation $hubClientInformation, ClientSessionInformation $clientSessionInformation, array<string|int, mixed> $getData, array<string|int, mixed> $postData, string $moduleCode) : string
Parameters
- $cartContent : CartContent
-
Cart content.
- $customerInformation : CustomerInformation
-
Customer information.
- $hubClientInformation : HubClientInformation
-
Hub client information.
- $clientSessionInformation : ClientSessionInformation
-
Session information.
- $getData : array<string|int, mixed>
-
GET-Request data.
- $postData : array<string|int, mixed>
-
POST-Request data.
- $moduleCode : string
-
Module Code.
Return values
string —Returns an confirmation contents array.
getTransactionDetails()
Returns the transaction details.
public
getTransactionDetails(HubTransactionCode $transactionCode) : array<string|int, mixed>
Parameters
- $transactionCode : HubTransactionCode
-
Transaction code.
Return values
array<string|int, mixed> —Returns the transaction details.
startTransaction()
Starts an transaction and returns the transaction code.
public
startTransaction(HubClientInformation $hubClientInformation, OrderContent $orderContent, ClientSessionInformation $clientSessionInformation) : string
Parameters
- $hubClientInformation : HubClientInformation
-
Hub client information.
- $orderContent : OrderContent
-
Order content.
- $clientSessionInformation : ClientSessionInformation
-
Session information.
Return values
string —Returns the transaction code.