Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/thorgate/django-thorbanks
Django application for Estonian banklinks
https://github.com/thorgate/django-thorbanks
Last synced: about 1 month ago
JSON representation
Django application for Estonian banklinks
- Host: GitHub
- URL: https://github.com/thorgate/django-thorbanks
- Owner: thorgate
- License: bsd-3-clause
- Created: 2014-08-08T15:24:47.000Z (over 10 years ago)
- Default Branch: main
- Last Pushed: 2024-01-03T09:51:41.000Z (about 1 year ago)
- Last Synced: 2024-11-19T11:21:16.067Z (about 2 months ago)
- Language: Python
- Size: 359 KB
- Stars: 6
- Watchers: 21
- Forks: 4
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# django-thorbanks
[](https://travis-ci.org/thorgate/django-thorbanks)
[](https://coveralls.io/github/thorgate/django-thorbanks?branch=master)
[](https://badge.fury.io/py/django-thorbanks)
Django app for integrating Estonian banklinks into your project.
## Features
Bank | Protocol | Authentication | Payment
--------------- | ----------- | ------------------- | -------
Swedbank | iPizza | :heavy_check_mark: | :heavy_check_mark:
SEB | iPizza | :heavy_check_mark: | :heavy_check_mark:
Danske | iPizza | :heavy_check_mark: | :heavy_check_mark:
LHV | iPizza | :heavy_check_mark: | :heavy_check_mark:
Krediidipank | iPizza | :heavy_check_mark: | :heavy_check_mark:
Nordea | iPizza | :heavy_check_mark: | :heavy_check_mark:
## Usage
### 1. Install it:
**Pip:**
```bash
pip install django-thorbanks
```
**Pipenv:**
```bash
pipenv install django-thorbanks
```
**Poetry:**
```bash
poetry add django-thorbanks
```
### 2. Add to installed apps
```python
INSTALLED_APPS = (
# Add the following apps:
"thorbanks",
"thorbanks_models",
)
```
### 3. Configure and create migrations:
**With MANUAL_MODELS:**
- Remove `"thorbanks_models"` from `INSTALLED_APPS`
- follow instructions from [thorbanks.settings.get_model](./thorbanks/settings.py#L59).
**With default models:**
Make django aware that thorbanks migrations are in your local apps folder via settings.MIGRATION_MODULES:
> Note: Replace `shop` with the name of an existing app in your project.
```python
# Tell django that thorbanks_models migrations are in shop app (in thorbanks_migrations module)
MIGRATION_MODULES = {"thorbanks_models": "shop.thorbanks_migrations"}
```
Now run `makemigrations thorbanks_models` and `migrate` management commands to create and apply the migrations.
### 4. Add settings.BANKLINKS
For a working example see the definitions in [example/settings.py](example/settings.py).
> Note:
>You will need a public and private key for each bank integration.
>In case you don't have the public key, you can generate one out of a certificate by:
>```
>openssl x509 -pubkey -noout -in cert.pem > pubkey.pem
>```
### 5. Link Transaction to your Order model
> Note: When using MANUAL_MODELS replace `thorbanks_models` with your local app name
```python
class Order(models.Model):
# ... other fields
transaction = models.OneToOneField(
"thorbanks_models.Transaction", null=True, on_delete=models.SET_NULL
)
```
### 6. Include thorbanks urls
```python
urlpatterns = [
# This is where the user will be redirected after returning from the banklink page
url(r"^banks/", include("thorbanks.urls")),
]
```
### 7. Add listeners to banklinks success & failure callbacks:
See [example.shop.models.banklink_success_callback](example/shop/models.py#L23) and [example.shop.models.banklink_failed_callback](example/shop/models.py#L44).
### 8. Create views and forms for payments:
see [example.shop.views](example/shop/views.py) and [example.shop.forms](example/shop/forms.py).
## iPizza protocol
- [Test service](https://banks.pastel.thorgate.eu/et/info)
- [Swedbank](https://www.swedbank.ee/business/cash/ecommerce/ecommerce?language=EST)
- [Spec](https://www.swedbank.ee/static/pdf/business/d2d/paymentcollection/Pangalingi_paringute_tehniline_spetsifikatsioon_09_10_2014.pdf)
- [SEB](https://www.seb.ee/ariklient/igapaevapangandus/pangalink)
- [LHV Bank](https://www.lhv.ee/pangateenused/pangalink/)