Documentation

[douglas-srs]

Hey there,

I would like to use your extension on my project but I didn't find any documentation available, can you provide me some examples on how to implement this?

[SilverFire]

Hello.

In order to use this module, add it to your application config as follows:

'modules' => [
        // ...
        'merchant' => [
            'class' => \hiqdev\yii2\merchant\Module::class,
            'returnPage' => '/finance/pay/return', // The route to page where user will be redirected after the success transaction
            'notifyPage' => '/finance/pay/notify', // The route that can be used by merchant to send payment notifications
            'finishPage' => '/finance/bill', // The page where the user will be redirected after waiting for transaction completion on success page
            'purchaseRequestCollectionClass' => your\app\PurchaseRequestCollection::class, // The class that extends `\hiqdev\yii2\merchant\Collection` and provides list of possible deposit requests that should be rendered as buttons.
        ],
]

Example of PurchaseRequestCollection you can find here.

Despite we use this project it in our production for more than 5 months, it's still quite unstable and we can not guarantee any backward compatibility. It case you still would like to use this extension, we recommend you to rely on some commit explicitly to prevent unexpected changes of behavior.

[SilverFire]

You will also need to implement hiqdev\yii2\merchant\transactions\TransactionRepositoryInterface to store information about payment transactions initiated by user, and register the implementation in DIC as a singleton. See example of configuration and implementation itself

[SilverFire]

Unfortunately, we don't have enough time to write documentation for this project.
In case you have any exact questions – post them, we will try to answer you asap. Maybe, it will result in a documentation issue that may be organized to a complete manual :)