Checkout Webhook

Checkout Webhook

After a successful Checkout transaction, a webhook is sent to your webhook url with the details of that transaction.

For a checkout transaction, the transaction.checkout object isn't null.

This object contains the revelant information about the transaction.

Sample Response

{
  "event": "checkout.success",
  "transaction": {
    "id": "d8d6fbb6-8e4d-4bed-bf96-084bf04eadea",
    "amount": 200000,
    "channel": "checkout",
    "refund": false,
    "checkout": {
      "id": "f8db902f-c1b1-4220-b12d-92b13e039a51",
      "amount": 200000,
      "email": "post@malone.co",
      "currency": "NGN",
      "status": "paid",
      "linked_account": {
        "user": {
          "name": "Kamsi Oleka",
          "identifier": "ezemmuo",
          "identifier_type": "username"
        },
        "business": {
          "name": "Cash App",
          "logo": "https://palaciodepeer.s3.us-east-2.amazonaws.com/business_logos/UJimBqYOu7KQIM3DwCWOuKjkDbBbVLYRuYRTgxKh.png",
          "logo_colour": "#77cc33"
        }
      },
      "meta": {
        "city": "Ketu",
        "state": "London"
      },
      "updated_at": "2023-05-19T16:36:14.000000Z",
      "created_at": "2023-05-19T16:35:43.000000Z"
    },
    "user": {
      "reference": "6eda3cfe-a81d-443a-be00-bde116135c46",
      "name": "Checkout",
      "identifier": "checkout",
      "identifier_type": "username",
      "email": "shop@thepeer.co",
      "created_at": "2023-05-19T10:16:18.000000Z",
      "updated_at": "2023-05-19T10:16:18.000000Z"
    },
    "charge": 2000,
    "currency": "NGN",
    "mode": "credit",
    "reference": "3db06a9183ac0af1d3594600d5191c74",
    "remark": "checkout",
    "status": "success",
    "type": "peer",
    "meta": {
      "city": "Ketu",
      "state": "London"
    },
    "peer": {
      "business": {
        "name": "Cash App",
        "logo": "https://palaciodepeer.s3.us-east-2.amazonaws.com/business_logos/UJimBqYOu7KQIM3DwCWOuKjkDbBbVLYRuYRTgxKh.png",
        "logo_colour": "#77cc33"
      },
      "user": {
        "name": "Kamsi Oleka",
        "identifier": "ezemmuo",
        "identifier_type": "username"
      }
    },
    "updated_at": "2023-05-19T16:36:13.000000Z",
    "created_at": "2023-05-19T16:36:13.000000Z"
  }
}

Webhook transaction object

Key	Description
channel	The channel the transaction went through. In this case, checkout
user	This is a checkout user created for the business being paid. It is NOT the user paying at checkout
peer.user	This is the user being charged for the transaction
peer.business	This is the business processing the initiated charge request
checkout.email	Customer's email address used in generating the checkout
checkout.linked_account.user	This is the user being charged for the transaction
checkout.linked_account.business	This is the business processing the initiated charge request