Payment Webhooks

Events

payment.completedA payment has been completed
payment.refundedA payment has been refunded

Fields

NameTypeDescription
paymentPayment The payment this event is related to
locationLocationTiny(optional) The location the payment belongs to if any
organizationOrganizationTiny The organization the payment belongs to

Example

{
  "event": "payment.completed",
  "payment": {
    "...": "..."
  },
  "location": {
    "id": "LOC123",
    "name": "Richmond"
  },
  "organization": {
    "id": "ORG001",
    "name": "My Awesome Business"
  }
}

In this article