Skip to content
This repository was archived by the owner on Nov 6, 2022. It is now read-only.

Commit f966f80

Browse files
author
Hugo Osvaldo Barrera
committed
Improve usage documentation
Add a bit more details about the general flow of things. Fixes #1
1 parent 47ce915 commit f966f80

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

README.rst

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -157,6 +157,17 @@ Finally, you can handle payment notifications in real time using a
157157
def process_payment(sender, instance=None, created=False, **kwargs):
158158
do_stuff()
159159

160+
To complete a full payment flow, you'd:
161+
162+
* Create a ``Preference``.
163+
* Use ``preference.url`` to forward the user to the payment page.
164+
* If your webhooks are properly configured, the notification will be created as
165+
soon as the user completes the operation.
166+
* Depending on your ``AUTOPROCESS`` setting, the status may be updated
167+
automatically, or may be up to you (see above).
168+
* If you're not using webhooks, you'll have to poll the status manually
169+
from time to time (using ``poll_status``).
170+
160171
Backwards compatibility
161172
-----------------------
162173

0 commit comments

Comments
 (0)