Start learning free

LESSON 109 OF 188 · BACKEND: PAYMENTS AND OTHER SERVICES

Webhooks: The Provider Calls You in Python

Practice

Some payments finish later, not during the request: the customer confirms in their bank's app a few minutes after checkout, or pays by bank transfer. Your shop can't wait for that. Instead, the provider calls your shop when it happens: it sends a POST to an address you gave it. That address is a webhook. For once, your shop is the server and the provider is the client.

Events: the provider sends an event as JSON: what happened in "type", and the payment it happened to in "data", a dictionary inside the dictionary. The same idea for a mail service that tells you an email bounced:

bounced = []

@app.post("/webhooks/mail")
def mail_webhook():
    event = request.get_json()
    if event["type"] == "email.bounced":
        bounced.append(event["data"]["to"])
    return jsonify({"received": True})

Answer {"received": true} to every event, even the ones you don't act on, like payment.failed: a provider resends an event until it gets a 2xx answer. The path has no id in it, so the order's id comes from the event, in "data":

POST /webhooks/payments  {"type": "payment.failed", "data": {"id": "pay_7", "amount": 21, "order_id": 10}}
                         →  200  {"received": true}
GET /orders/10           →  200  {…, "payment_id": null, "status": "pending", "total": 21}
POST /webhooks/payments  {"type": "payment.succeeded", "data": {"id": "pay_8", "amount": 21, "order_id": 10}}
                         →  200  {"received": true}
GET /orders/10           →  200  {…, "payment_id": "pay_8", "status": "paid", "total": 21}

Your task: add POST /webhooks/payments with a function payment_webhook. Read the event, and when its type is "payment.succeeded", mark the order paid with the payment's id. Answer {"received": true} for every event.


Assignment
Follow the Coding Tutorial to build the webhook POST /webhooks/payments.


Hint
The payment is event["data"]. Use the same UPDATE as in pay_order, with the payment's "id" and its "order_id", and don't forget db.commit().


STEP 1 OF 8
    Ctrl + Enter to check

    Pay Webhook in Python

    Keep going with Python1,600+ step-by-step lessons, from your first line of code to coding interviews. Free to start.
    Start learning free