Skip to content

Latest commit

 

History

History
77 lines (50 loc) · 2.52 KB

payment_methods.rst

File metadata and controls

77 lines (50 loc) · 2.52 KB
Raw

Payment methods

This guide will show how a moderately complex payment method can be implemented. There are two main components in Salesman's payment method interface:

  • Basket payment is used during checkout where a basket get's converted to an order.
  • Order payment is used when a payment is requested for an existing order.

You can optionally support either one or both methods in your payment method.

Payment methods are registered in SALESMAN_PAYMENT_METHODS setting and should be formatted as a list of dotted paths to a class extending salesman.checkout.payment.PaymentMethod class. Defined payments are required to specify a label and a unique identifier property.

Note

For this example, we assume your custom app is named shop.

Validate payments

Payment methods can be validated for both the basket and order instances. This is useful when you wish to disable certain payments for a given request.

Default validations are included with base salesman.checkout.payment.PaymentMethod class:

/../salesman/checkout/payment.py

/../salesman/checkout/payment.py

Note

To include base validation be sure to call super() when overriding validation.

Basket validation example

In this example, we create an on-delivery payment method that is only valid when less that 10 items are in the basket.

/../example/shop/payment/on_delivery.py

Now only baskets with less than 10 items will be eligible for payment on delivery.

Credit card example

A more complex example using an off-site dummy gateway.

/../example/shop/payment/credit_card.py

Register payments

Enable payment methods by adding in settings.py:

SALESMAN_PAYMENT_METHODS = [
    'shop.payment.PayOnDelivery',
    'shop.payment.CreditCardPayment',
]

You can now select those payment methods in checkout and order payment operations.

External packages

Official payment methods are provided as external packages that can be used for simple implementations or as examples on how to implement your own.