fred-pain

https://gitlab.office.nic.cz/fred/pain

Provides payment processor for FRED.

payments-pain

https://gitlab.office.nic.cz/ginger/payments-pain

Provides payment processor for Ginger Payments (and therefore the Academy).

PAIN_PROCESSORS

A required setting containing a dictionary of payment processor names and dotted paths to payment processors classes. The payments are offered to the payment processors in that order.

Example configuration:

PAIN_PROCESSORS = {
    'fred': 'fred_pain.processors.FredPaymentProcessor',
    'payments': 'payments_pain.processors.PaymentsPaymentProcessor',
    'ignore': 'django_pain.processors.IgnorePaymentProcessor',
}

You should not change processor names unless you have a very good reason. In that case, you also need to take care of changing processor names saved in the database.

When you change this setting (including the initial setup), you have to run django-admin migrate. Permissions for manual assignment to individual payment processors are created in this step.

PAIN_PROCESS_PAYMENTS_LOCK_FILE

Path to the lock file for the process_payments command. The default value is /tmp/pain_process_payments.lock.

PAIN_TRIM_VARSYM

Boolean setting. If True, bank statement parser removes leading zeros from the variable symbol. Default is False.

PAIN_DOWNLOADERS

A setting containing dotted paths to payment downloader and parser classes and downloader parameters. There should be a separate entry in the dictionary for each bank from which payments should be downloaded. The downloaders and parsers are provided in teller library.

Example configuration:

DOWNLOADERS = {'test_bank': {'DOWNLOADER': 'teller.downloaders.TestStatementDownloader',
                             'PARSER': 'teller.downloaders.TestStatementParser',
                             'DOWNLOADER_PARAMS': {'base_url': 'https://bank.test', 'password': 'letmein'}}}

PAIN_IMPORT_CALLBACK

List setting containing dotted paths to callables.

Each value of the list should be dotted path refering to callable that takes BankPayment object as its argument and returns (possibly) changed BankPayment. This callable is called right before the payment is saved during the import. Especially, this callable can throw ValidationError in order to avoid saving payment to the database. Default value is empty list.

PAIN_CSOB_CARD

Settings for CSOB card payment handler. API_PUBLIC_KEY, MERCHANT_ID and MERCHANT_PRIVATE_KEY contain parameters provided by CSOB bank. ACCOUNT_NUMBERS is a mapping assigning accounts to curency codes. CSOB payment gateway may accept payments in different currencies. For each currency there has to be an account held in that currency associated with the gateway. The associated accounts have to be specified in ACCOUNT_NUMBERS setting so we are able to choose the correct account when recording the payments in the application. The values of the mapping are account numbers as recorded in the database.

Example configuration:

PAIN_CSOB_CARD = {
    'API_PUBLIC_KEY': 'path_to_public_key.txt'),
    'MERCHANT_ID': 'abc123',
    'MERCHANT_PRIVATE_KEY': 'path_to_private_key.txt'),
    'ACCOUNT_NUMBERS': {
        'CZK': '123456',
        'EUR': '234567',
    },
}

CURRENCIES

A list of currency codes used in the application. The default is the list of all available currencies (which is pretty long).

Example configuration:

CURRENCIES = ['CZK', 'EUR', 'USD']

This setting comes from django-money app. Changing this setting requires generating migrations.

DEFAULT_CURRENCY

The currency code of the default currency. It should be one of the currencies defined in the CURRENCIES setting. The default is XYZ.

Example configuration:

DEFAULT_CURRENCY = 'CZK'

This setting comes from django-money app. Changing this setting requires generating migrations.

LANGUAGES

See Django docs. It is advisable to set this only to languages you intend to support. django-pain natively comes with English and Czech.

Currency formatting

In case Django does not format currencies correctly according to its locale setting it may be necessary to define the formatting rules manually:

from moneyed.localization import _FORMATTER as money_formatter
from decimal import ROUND_HALF_UP
money_formatter.add_formatting_definition(
    'cs', group_size=3, group_separator=' ', decimal_point=',',
    positive_sign='',  trailing_positive_sign='',
    negative_sign='-', trailing_negative_sign='',
    rounding_method=ROUND_HALF_UP
)

First argument of add_formatting_definition should be a properly formatted locale name from the LANGUAGES setting.

This setting comes from py-moneyed library.

import_payments

import_payments --parser PARSER [input file [input file ...]]

Import payments from the bank. A bank statement should be provided on the standard input or in a file as a positional parameter.

The mandatory argument PARSER must be a dotted path to a payment-parser class such as django_pain.parsers.transproc.TransprocXMLParser.

download_payments

download_payments [--start START] [--end END] [--downloader DOWNLOADER]

Download payments from the banks.

There are two optional arguments --start and --end which set the download interval for which the banks will be queried. Both parameters should be entered as date and time in ISO format. Default value for END is today. Default value for START is seven days before END.

Example download_payments --start 2020-09-01T00:00 --end 2020-10-31T23:59

Optional repeatable parameter --downloader selects which downloaders defined in the PAIN_DOWNLOADERS settings will be used. If the parameter is omitted all defined downloaders will be used.

Example download_payments --downloader somebank --downloader someotherbank

list_payments

list_payments [--exclude-accounts ACCOUNTS]
              [--include-accounts ACCOUNTS]
              [--limit LIMIT] [--state STATE]

List bank payments.

The options --exclude-accounts and --include-accounts are mutually exclusive and expect a comma-separated list of bank account numbers.

Option --state can be either ready_to_process, processed, deferred or exported.

If --limit LIMIT is set, the command will list at most LIMIT payments. If there are any non-listed payments, the command will announce their count.

process_payments

process_payments [--from TIME_FROM] [--to TIME_TO]

Process unprocessed payments with predefined payment processors.

The command takes all payments in the states ready_to_process or deferred and offers them to the individual payment processors. If any processor accepts the payment, then payment’s state is switched to processed. Otherwise, its state is switched to deferred.

The options --from and --to limit payments to be processed by their creation date. They expect an ISO-formatted datetime value.