Payment Webhooks

Events

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

Fields

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

Example

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

In this article