Webhooks

Listen for events on your account so your integration can automatically trigger reactions.

Event-driven
Webhooks are HTTP callbacks that we send to your endpoint when specific events occur in your account.
Reliable delivery
We automatically retry failed webhook deliveries with exponential backoff for up to 3 days.
Webhook endpoint structure
Your webhook endpoint should be able to handle the following HTTP request structure:

Headers

Content-Typeapplication/json
X-Webhook-Signaturesha256=...
User-AgentYourAPI-Webhooks/1.0

Verification

javascript
const crypto = require('crypto');\n\nfunction verifyWebhook(payload, signature) {\n  const expectedSignature = crypto\n    .createHmac('sha256', POLLEN_PAY_API_SECRET_KEY)\n    .update(payload, 'utf8')\n    .digest('hex');\n  \n  return signature === `sha256=${expectedSignature}`;\n}

Event types

order_request
A request to create an order that needs settling.

Event object

eventId
string

Unique identifier for the order event.

orderId
string

The ID of the order this event belongs to. (References Order)

timestamp
integer

Unix timestamp of when the event occurred.

type
string

The type of order event.

outstanding
string

The outstanding amount at the time of the event, or a relevant note.

requestedReceipt
array

A revised receipt, representing a list of products, similar to a basket's product structure, if the basket/order was adjusted.

Array items contain:

requestedReceipt[].name
string
required

Name of the product.

requestedReceipt[].price
number
required

Price of the product.

requestedReceipt[].currency
string
required

Currency of the price (e.g., 'GBP', 'USD').

requestedReceipt[].vat
number

Value Added Tax percentage.

requestedReceipt[].qty
integer
required

Quantity of the product.

requestedReceipt[].discount
number

Discount applied to the product.

Example payload

json
{
  "eventId": "evt_1a2b3c4d-5e6f-7890-1234-567890abcdef",
  "orderId": "ord_a1b2c3d4-e5f6-7890-1234-567890abcdef",
  "timestamp": 1678886400,
  "type": "order_request",
  "outstanding": "6250",
  "requestedReceipt": [
    {
      "name": "Product X",
      "price": 5000,
      "currency": "GBP",
      "vat": 20,
      "qty": 1,
      "discount": 0
    },
    {
      "name": "Product Y",
      "price": 5000,
      "currency": "GBP",
      "vat": 20,
      "qty": 1,
      "discount": 0
    }
  ]
}
order_creation
The initial event when an order is first created.

Event object

eventId
string

Unique identifier for the order event.

orderId
string

The ID of the order this event belongs to. (References Order)

timestamp
integer

Unix timestamp of when the event occurred.

type
string

The type of order event.

outstanding
string

The outstanding amount at the time of the event, or a relevant note.

Example payload

json
{
  "eventId": "evt_1a2b3c4d-5e6f-7890-1234-567890abcdef",
  "orderId": "ord_a1b2c3d4-e5f6-7890-1234-567890abcdef",
  "timestamp": 1678886400,
  "type": "order_creation",
  "outstanding": "6250"
}
defcon_up
Indicates an escalation in the order's risk or delinquency status.

Event object

eventId
string

Unique identifier for the order event.

orderId
string

The ID of the order this event belongs to. (References Order)

timestamp
integer

Unix timestamp of when the event occurred.

type
string

The type of order event.

outstanding
string

The outstanding amount at the time of the event, or a relevant note.

Example payload

json
{
  "eventId": "evt_1a2b3c4d-5e6f-7890-1234-567890abcdef",
  "orderId": "ord_a1b2c3d4-e5f6-7890-1234-567890abcdef",
  "timestamp": 1678886400,
  "type": "defcon_up",
  "outstanding": "6250"
}
defcon_down
Indicates a de-escalation in the order's risk or delinquency status.

Event object

eventId
string

Unique identifier for the order event.

orderId
string

The ID of the order this event belongs to. (References Order)

timestamp
integer

Unix timestamp of when the event occurred.

type
string

The type of order event.

outstanding
string

The outstanding amount at the time of the event, or a relevant note.

Example payload

json
{
  "eventId": "evt_1a2b3c4d-5e6f-7890-1234-567890abcdef",
  "orderId": "ord_a1b2c3d4-e5f6-7890-1234-567890abcdef",
  "timestamp": 1678886400,
  "type": "defcon_down",
  "outstanding": "6250"
}
admin_order_archived
An order has been archived by an administrator.

Event object

eventId
string

Unique identifier for the order event.

orderId
string

The ID of the order this event belongs to. (References Order)

timestamp
integer

Unix timestamp of when the event occurred.

type
string

The type of order event.

outstanding
string

The outstanding amount at the time of the event, or a relevant note.

Example payload

json
{
  "eventId": "evt_1a2b3c4d-5e6f-7890-1234-567890abcdef",
  "orderId": "ord_a1b2c3d4-e5f6-7890-1234-567890abcdef",
  "timestamp": 1678886400,
  "type": "admin_order_archived",
  "outstanding": "6250"
}
order_completed
The order has been fully paid and completed.

Event object

eventId
string

Unique identifier for the order event.

orderId
string

The ID of the order this event belongs to. (References Order)

timestamp
integer

Unix timestamp of when the event occurred.

type
string

The type of order event.

outstanding
string

The outstanding amount at the time of the event, or a relevant note.

Example payload

json
{
  "eventId": "evt_1a2b3c4d-5e6f-7890-1234-567890abcdef",
  "orderId": "ord_a1b2c3d4-e5f6-7890-1234-567890abcdef",
  "timestamp": 1678886400,
  "type": "order_completed",
  "outstanding": "0"
}
admin_bad_debt
An administrator has marked the order as bad debt.

Event object

eventId
string

Unique identifier for the order event.

orderId
string

The ID of the order this event belongs to. (References Order)

timestamp
integer

Unix timestamp of when the event occurred.

type
string

The type of order event.

outstanding
string

The outstanding amount at the time of the event, or a relevant note.

Example payload

json
{
  "eventId": "evt_1a2b3c4d-5e6f-7890-1234-567890abcdef",
  "orderId": "ord_a1b2c3d4-e5f6-7890-1234-567890abcdef",
  "timestamp": 1678886400,
  "type": "admin_bad_debt",
  "outstanding": "6250"
}
admin_passed_for_collection
An administrator has passed the order to a collection agency.

Event object

eventId
string

Unique identifier for the order event.

orderId
string

The ID of the order this event belongs to. (References Order)

timestamp
integer

Unix timestamp of when the event occurred.

type
string

The type of order event.

outstanding
string

The outstanding amount at the time of the event, or a relevant note.

Example payload

json
{
  "eventId": "evt_1a2b3c4d-5e6f-7890-1234-567890abcdef",
  "orderId": "ord_a1b2c3d4-e5f6-7890-1234-567890abcdef",
  "timestamp": 1678886400,
  "type": "admin_passed_for_collection",
  "outstanding": "6250"
}
admin_vulnerabe_customer
An administrator has flagged the customer as vulnerable.

Event object

eventId
string

Unique identifier for the order event.

orderId
string

The ID of the order this event belongs to. (References Order)

timestamp
integer

Unix timestamp of when the event occurred.

type
string

The type of order event.

outstanding
string

The outstanding amount at the time of the event, or a relevant note.

Example payload

json
{
  "eventId": "evt_1a2b3c4d-5e6f-7890-1234-567890abcdef",
  "orderId": "ord_a1b2c3d4-e5f6-7890-1234-567890abcdef",
  "timestamp": 1678886400,
  "type": "admin_vulnerabe_customer",
  "outstanding": "6250"
}
reminder_email
A reminder email has been sent for a payment.

Event object

eventId
string

Unique identifier for the order event.

orderId
string

The ID of the order this event belongs to. (References Order)

timestamp
integer

Unix timestamp of when the event occurred.

type
string

The type of order event.

outstanding
string

The outstanding amount at the time of the event, or a relevant note.

payment
object

Optional full payment object associated with this event. (References Payment)

Object properties:

payment.id
string
required

Unique identifier for the payment.

payment.currency
string

The currency of the payment (e.g., 'GBP').

payment.amount
integer
required

The amount of the payment in pence (or smallest currency unit).

payment.type
string
required

The type of payment (e.g., 'buy_in', 'scheduled').

payment.status
string
required

The current status of the payment.

payment.dueDate
integer
required

Unix timestamp of when the payment is due.

payment.factDate
integer

Unix timestamp of when the payment was actually made (if applicable).

payment.lateFee
integer

Any late fee applied to the payment in pence.

payment.orderId
string
required

The ID of the order this payment belongs to.

payment.paymentMethodBrand
string

The brand of the payment method (e.g., 'Visa', 'Mastercard', 'Amex', 'PayPal').

payment.last4
string

The last four digits of the payment card, if applicable.

Example payload

json
{
  "eventId": "evt_1a2b3c4d-5e6f-7890-1234-567890abcdef",
  "orderId": "ord_a1b2c3d4-e5f6-7890-1234-567890abcdef",
  "timestamp": 1678886400,
  "type": "reminder_email",
  "outstanding": "6250",
  "payment": {
    "id": "pay_x1y2z3a4-b5c6-7890-1234-567890abcdef",
    "currency": "GBP",
    "amount": 10000,
    "type": "manual",
    "status": "paid",
    "dueDate": 1678886400,
    "factDate": 1678886400,
    "lateFee": null,
    "orderId": "ord_a1b2c3d4-e5f6-7890-1234-567890abcdef",
    "paymentMethodBrand": "Visa",
    "last4": "4242"
  }
}
reminder_message
A reminder message (e.g., SMS) has been sent for a payment.

Event object

eventId
string

Unique identifier for the order event.

orderId
string

The ID of the order this event belongs to. (References Order)

timestamp
integer

Unix timestamp of when the event occurred.

type
string

The type of order event.

outstanding
string

The outstanding amount at the time of the event, or a relevant note.

payment
object

Optional full payment object associated with this event. (References Payment)

Object properties:

payment.id
string
required

Unique identifier for the payment.

payment.currency
string

The currency of the payment (e.g., 'GBP').

payment.amount
integer
required

The amount of the payment in pence (or smallest currency unit).

payment.type
string
required

The type of payment (e.g., 'buy_in', 'scheduled').

payment.status
string
required

The current status of the payment.

payment.dueDate
integer
required

Unix timestamp of when the payment is due.

payment.factDate
integer

Unix timestamp of when the payment was actually made (if applicable).

payment.lateFee
integer

Any late fee applied to the payment in pence.

payment.orderId
string
required

The ID of the order this payment belongs to.

payment.paymentMethodBrand
string

The brand of the payment method (e.g., 'Visa', 'Mastercard', 'Amex', 'PayPal').

payment.last4
string

The last four digits of the payment card, if applicable.

Example payload

json
{
  "eventId": "evt_1a2b3c4d-5e6f-7890-1234-567890abcdef",
  "orderId": "ord_a1b2c3d4-e5f6-7890-1234-567890abcdef",
  "timestamp": 1678886400,
  "type": "reminder_message",
  "outstanding": "6250",
  "payment": {
    "id": "pay_x1y2z3a4-b5c6-7890-1234-567890abcdef",
    "currency": "GBP",
    "amount": 10000,
    "type": "manual",
    "status": "paid",
    "dueDate": 1678886400,
    "factDate": 1678886400,
    "lateFee": null,
    "orderId": "ord_a1b2c3d4-e5f6-7890-1234-567890abcdef",
    "paymentMethodBrand": "Visa",
    "last4": "4242"
  }
}
scheduled_payment_attempt
An automated attempt was made to process a scheduled payment.

Event object

eventId
string

Unique identifier for the order event.

orderId
string

The ID of the order this event belongs to. (References Order)

timestamp
integer

Unix timestamp of when the event occurred.

type
string

The type of order event.

outstanding
string

The outstanding amount at the time of the event, or a relevant note.

payment
object

Optional full payment object associated with this event. (References Payment)

Object properties:

payment.id
string
required

Unique identifier for the payment.

payment.currency
string

The currency of the payment (e.g., 'GBP').

payment.amount
integer
required

The amount of the payment in pence (or smallest currency unit).

payment.type
string
required

The type of payment (e.g., 'buy_in', 'scheduled').

payment.status
string
required

The current status of the payment.

payment.dueDate
integer
required

Unix timestamp of when the payment is due.

payment.factDate
integer

Unix timestamp of when the payment was actually made (if applicable).

payment.lateFee
integer

Any late fee applied to the payment in pence.

payment.orderId
string
required

The ID of the order this payment belongs to.

payment.paymentMethodBrand
string

The brand of the payment method (e.g., 'Visa', 'Mastercard', 'Amex', 'PayPal').

payment.last4
string

The last four digits of the payment card, if applicable.

Example payload

json
{
  "eventId": "evt_1a2b3c4d-5e6f-7890-1234-567890abcdef",
  "orderId": "ord_a1b2c3d4-e5f6-7890-1234-567890abcdef",
  "timestamp": 1678886400,
  "type": "scheduled_payment_attempt",
  "outstanding": "6250",
  "payment": {
    "id": "pay_x1y2z3a4-b5c6-7890-1234-567890abcdef",
    "currency": "GBP",
    "amount": 10000,
    "type": "manual",
    "status": "paid",
    "dueDate": 1678886400,
    "factDate": 1678886400,
    "lateFee": null,
    "orderId": "ord_a1b2c3d4-e5f6-7890-1234-567890abcdef",
    "paymentMethodBrand": "Visa",
    "last4": "4242"
  }
}
manual_payment_attempt
A manual attempt was made by the customer to process a payment.

Event object

eventId
string

Unique identifier for the order event.

orderId
string

The ID of the order this event belongs to. (References Order)

timestamp
integer

Unix timestamp of when the event occurred.

type
string

The type of order event.

outstanding
string

The outstanding amount at the time of the event, or a relevant note.

payment
object

Optional full payment object associated with this event. (References Payment)

Object properties:

payment.id
string
required

Unique identifier for the payment.

payment.currency
string

The currency of the payment (e.g., 'GBP').

payment.amount
integer
required

The amount of the payment in pence (or smallest currency unit).

payment.type
string
required

The type of payment (e.g., 'buy_in', 'scheduled').

payment.status
string
required

The current status of the payment.

payment.dueDate
integer
required

Unix timestamp of when the payment is due.

payment.factDate
integer

Unix timestamp of when the payment was actually made (if applicable).

payment.lateFee
integer

Any late fee applied to the payment in pence.

payment.orderId
string
required

The ID of the order this payment belongs to.

payment.paymentMethodBrand
string

The brand of the payment method (e.g., 'Visa', 'Mastercard', 'Amex', 'PayPal').

payment.last4
string

The last four digits of the payment card, if applicable.

Example payload

json
{
  "eventId": "evt_1a2b3c4d-5e6f-7890-1234-567890abcdef",
  "orderId": "ord_a1b2c3d4-e5f6-7890-1234-567890abcdef",
  "timestamp": 1678886400,
  "type": "manual_payment_attempt",
  "outstanding": "6250",
  "payment": {
    "id": "pay_x1y2z3a4-b5c6-7890-1234-567890abcdef",
    "currency": "GBP",
    "amount": 10000,
    "type": "manual",
    "status": "paid",
    "dueDate": 1678886400,
    "factDate": 1678886400,
    "lateFee": null,
    "orderId": "ord_a1b2c3d4-e5f6-7890-1234-567890abcdef",
    "paymentMethodBrand": "Visa",
    "last4": "4242"
  }
}
payment_succes
A payment has been successfully processed.

Event object

eventId
string

Unique identifier for the order event.

orderId
string

The ID of the order this event belongs to. (References Order)

timestamp
integer

Unix timestamp of when the event occurred.

type
string

The type of order event.

outstanding
string

The outstanding amount at the time of the event, or a relevant note.

payment
object

Optional full payment object associated with this event. (References Payment)

Object properties:

payment.id
string
required

Unique identifier for the payment.

payment.currency
string

The currency of the payment (e.g., 'GBP').

payment.amount
integer
required

The amount of the payment in pence (or smallest currency unit).

payment.type
string
required

The type of payment (e.g., 'buy_in', 'scheduled').

payment.status
string
required

The current status of the payment.

payment.dueDate
integer
required

Unix timestamp of when the payment is due.

payment.factDate
integer

Unix timestamp of when the payment was actually made (if applicable).

payment.lateFee
integer

Any late fee applied to the payment in pence.

payment.orderId
string
required

The ID of the order this payment belongs to.

payment.paymentMethodBrand
string

The brand of the payment method (e.g., 'Visa', 'Mastercard', 'Amex', 'PayPal').

payment.last4
string

The last four digits of the payment card, if applicable.

Example payload

json
{
  "eventId": "evt_1a2b3c4d-5e6f-7890-1234-567890abcdef",
  "orderId": "ord_a1b2c3d4-e5f6-7890-1234-567890abcdef",
  "timestamp": 1678886400,
  "type": "payment_succes",
  "outstanding": "6250",
  "payment": {
    "id": "pay_x1y2z3a4-b5c6-7890-1234-567890abcdef",
    "currency": "GBP",
    "amount": 10000,
    "type": "manual",
    "status": "paid",
    "dueDate": 1678886400,
    "factDate": 1678886400,
    "lateFee": null,
    "orderId": "ord_a1b2c3d4-e5f6-7890-1234-567890abcdef",
    "paymentMethodBrand": "Visa",
    "last4": "4242"
  }
}
payment_error
An error occurred during a payment attempt.

Event object

eventId
string

Unique identifier for the order event.

orderId
string

The ID of the order this event belongs to. (References Order)

timestamp
integer

Unix timestamp of when the event occurred.

type
string

The type of order event.

outstanding
string

The outstanding amount at the time of the event, or a relevant note.

payment
object

Optional full payment object associated with this event. (References Payment)

Object properties:

payment.id
string
required

Unique identifier for the payment.

payment.currency
string

The currency of the payment (e.g., 'GBP').

payment.amount
integer
required

The amount of the payment in pence (or smallest currency unit).

payment.type
string
required

The type of payment (e.g., 'buy_in', 'scheduled').

payment.status
string
required

The current status of the payment.

payment.dueDate
integer
required

Unix timestamp of when the payment is due.

payment.factDate
integer

Unix timestamp of when the payment was actually made (if applicable).

payment.lateFee
integer

Any late fee applied to the payment in pence.

payment.orderId
string
required

The ID of the order this payment belongs to.

payment.paymentMethodBrand
string

The brand of the payment method (e.g., 'Visa', 'Mastercard', 'Amex', 'PayPal').

payment.last4
string

The last four digits of the payment card, if applicable.

Example payload

json
{
  "eventId": "evt_1a2b3c4d-5e6f-7890-1234-567890abcdef",
  "orderId": "ord_a1b2c3d4-e5f6-7890-1234-567890abcdef",
  "timestamp": 1678886400,
  "type": "payment_error",
  "outstanding": "6250",
  "payment": {
    "id": "pay_x1y2z3a4-b5c6-7890-1234-567890abcdef",
    "currency": "GBP",
    "amount": 10000,
    "type": "manual",
    "status": "paid",
    "dueDate": 1678886400,
    "factDate": 1678886400,
    "lateFee": null,
    "orderId": "ord_a1b2c3d4-e5f6-7890-1234-567890abcdef",
    "paymentMethodBrand": "Visa",
    "last4": "4242"
  }
}
missed_payment
A scheduled payment was not made by its due date.

Event object

eventId
string

Unique identifier for the order event.

orderId
string

The ID of the order this event belongs to. (References Order)

timestamp
integer

Unix timestamp of when the event occurred.

type
string

The type of order event.

outstanding
string

The outstanding amount at the time of the event, or a relevant note.

payment
object

Optional full payment object associated with this event. (References Payment)

Object properties:

payment.id
string
required

Unique identifier for the payment.

payment.currency
string

The currency of the payment (e.g., 'GBP').

payment.amount
integer
required

The amount of the payment in pence (or smallest currency unit).

payment.type
string
required

The type of payment (e.g., 'buy_in', 'scheduled').

payment.status
string
required

The current status of the payment.

payment.dueDate
integer
required

Unix timestamp of when the payment is due.

payment.factDate
integer

Unix timestamp of when the payment was actually made (if applicable).

payment.lateFee
integer

Any late fee applied to the payment in pence.

payment.orderId
string
required

The ID of the order this payment belongs to.

payment.paymentMethodBrand
string

The brand of the payment method (e.g., 'Visa', 'Mastercard', 'Amex', 'PayPal').

payment.last4
string

The last four digits of the payment card, if applicable.

Example payload

json
{
  "eventId": "evt_1a2b3c4d-5e6f-7890-1234-567890abcdef",
  "orderId": "ord_a1b2c3d4-e5f6-7890-1234-567890abcdef",
  "timestamp": 1678886400,
  "type": "missed_payment",
  "outstanding": "6250",
  "payment": {
    "id": "pay_x1y2z3a4-b5c6-7890-1234-567890abcdef",
    "currency": "GBP",
    "amount": 10000,
    "type": "manual",
    "status": "paid",
    "dueDate": 1678886400,
    "factDate": 1678886400,
    "lateFee": null,
    "orderId": "ord_a1b2c3d4-e5f6-7890-1234-567890abcdef",
    "paymentMethodBrand": "Visa",
    "last4": "4242"
  }
}
fee_levied
A new fee has been applied to the order.

Event object

eventId
string

Unique identifier for the order event.

orderId
string

The ID of the order this event belongs to. (References Order)

timestamp
integer

Unix timestamp of when the event occurred.

type
string

The type of order event.

outstanding
string

The outstanding amount at the time of the event, or a relevant note.

payment
object

Optional full payment object associated with this event. (References Payment)

Object properties:

payment.id
string
required

Unique identifier for the payment.

payment.currency
string

The currency of the payment (e.g., 'GBP').

payment.amount
integer
required

The amount of the payment in pence (or smallest currency unit).

payment.type
string
required

The type of payment (e.g., 'buy_in', 'scheduled').

payment.status
string
required

The current status of the payment.

payment.dueDate
integer
required

Unix timestamp of when the payment is due.

payment.factDate
integer

Unix timestamp of when the payment was actually made (if applicable).

payment.lateFee
integer

Any late fee applied to the payment in pence.

payment.orderId
string
required

The ID of the order this payment belongs to.

payment.paymentMethodBrand
string

The brand of the payment method (e.g., 'Visa', 'Mastercard', 'Amex', 'PayPal').

payment.last4
string

The last four digits of the payment card, if applicable.

Example payload

json
{
  "eventId": "evt_1a2b3c4d-5e6f-7890-1234-567890abcdef",
  "orderId": "ord_a1b2c3d4-e5f6-7890-1234-567890abcdef",
  "timestamp": 1678886400,
  "type": "fee_levied",
  "outstanding": "6250",
  "payment": {
    "id": "pay_x1y2z3a4-b5c6-7890-1234-567890abcdef",
    "currency": "GBP",
    "amount": 10000,
    "type": "manual",
    "status": "paid",
    "dueDate": 1678886400,
    "factDate": 1678886400,
    "lateFee": null,
    "orderId": "ord_a1b2c3d4-e5f6-7890-1234-567890abcdef",
    "paymentMethodBrand": "Visa",
    "last4": "4242"
  }
}
fees_adjusted
Fees on the order have been modified.

Event object

eventId
string

Unique identifier for the order event.

orderId
string

The ID of the order this event belongs to. (References Order)

timestamp
integer

Unix timestamp of when the event occurred.

type
string

The type of order event.

outstanding
string

The outstanding amount at the time of the event, or a relevant note.

payment
object

Optional full payment object associated with this event. (References Payment)

Object properties:

payment.id
string
required

Unique identifier for the payment.

payment.currency
string

The currency of the payment (e.g., 'GBP').

payment.amount
integer
required

The amount of the payment in pence (or smallest currency unit).

payment.type
string
required

The type of payment (e.g., 'buy_in', 'scheduled').

payment.status
string
required

The current status of the payment.

payment.dueDate
integer
required

Unix timestamp of when the payment is due.

payment.factDate
integer

Unix timestamp of when the payment was actually made (if applicable).

payment.lateFee
integer

Any late fee applied to the payment in pence.

payment.orderId
string
required

The ID of the order this payment belongs to.

payment.paymentMethodBrand
string

The brand of the payment method (e.g., 'Visa', 'Mastercard', 'Amex', 'PayPal').

payment.last4
string

The last four digits of the payment card, if applicable.

Example payload

json
{
  "eventId": "evt_1a2b3c4d-5e6f-7890-1234-567890abcdef",
  "orderId": "ord_a1b2c3d4-e5f6-7890-1234-567890abcdef",
  "timestamp": 1678886400,
  "type": "fees_adjusted",
  "outstanding": "6250",
  "payment": {
    "id": "pay_x1y2z3a4-b5c6-7890-1234-567890abcdef",
    "currency": "GBP",
    "amount": 10000,
    "type": "manual",
    "status": "paid",
    "dueDate": 1678886400,
    "factDate": 1678886400,
    "lateFee": null,
    "orderId": "ord_a1b2c3d4-e5f6-7890-1234-567890abcdef",
    "paymentMethodBrand": "Visa",
    "last4": "4242"
  }
}
fee_paid
A specific fee has been paid.

Event object

eventId
string

Unique identifier for the order event.

orderId
string

The ID of the order this event belongs to. (References Order)

timestamp
integer

Unix timestamp of when the event occurred.

type
string

The type of order event.

outstanding
string

The outstanding amount at the time of the event, or a relevant note.

payment
object

Optional full payment object associated with this event. (References Payment)

Object properties:

payment.id
string
required

Unique identifier for the payment.

payment.currency
string

The currency of the payment (e.g., 'GBP').

payment.amount
integer
required

The amount of the payment in pence (or smallest currency unit).

payment.type
string
required

The type of payment (e.g., 'buy_in', 'scheduled').

payment.status
string
required

The current status of the payment.

payment.dueDate
integer
required

Unix timestamp of when the payment is due.

payment.factDate
integer

Unix timestamp of when the payment was actually made (if applicable).

payment.lateFee
integer

Any late fee applied to the payment in pence.

payment.orderId
string
required

The ID of the order this payment belongs to.

payment.paymentMethodBrand
string

The brand of the payment method (e.g., 'Visa', 'Mastercard', 'Amex', 'PayPal').

payment.last4
string

The last four digits of the payment card, if applicable.

Example payload

json
{
  "eventId": "evt_1a2b3c4d-5e6f-7890-1234-567890abcdef",
  "orderId": "ord_a1b2c3d4-e5f6-7890-1234-567890abcdef",
  "timestamp": 1678886400,
  "type": "fee_paid",
  "outstanding": "6250",
  "payment": {
    "id": "pay_x1y2z3a4-b5c6-7890-1234-567890abcdef",
    "currency": "GBP",
    "amount": 10000,
    "type": "manual",
    "status": "paid",
    "dueDate": 1678886400,
    "factDate": 1678886400,
    "lateFee": null,
    "orderId": "ord_a1b2c3d4-e5f6-7890-1234-567890abcdef",
    "paymentMethodBrand": "Visa",
    "last4": "4242"
  }
}
schedule_altered
The payment schedule for the order has been changed, typically at the user's request.

Event object

eventId
string

Unique identifier for the order event.

orderId
string

The ID of the order this event belongs to. (References Order)

timestamp
integer

Unix timestamp of when the event occurred.

type
string

The type of order event.

outstanding
string

The outstanding amount at the time of the event, or a relevant note.

payment
object

Optional full payment object associated with this event. (References Payment)

Object properties:

payment.id
string
required

Unique identifier for the payment.

payment.currency
string

The currency of the payment (e.g., 'GBP').

payment.amount
integer
required

The amount of the payment in pence (or smallest currency unit).

payment.type
string
required

The type of payment (e.g., 'buy_in', 'scheduled').

payment.status
string
required

The current status of the payment.

payment.dueDate
integer
required

Unix timestamp of when the payment is due.

payment.factDate
integer

Unix timestamp of when the payment was actually made (if applicable).

payment.lateFee
integer

Any late fee applied to the payment in pence.

payment.orderId
string
required

The ID of the order this payment belongs to.

payment.paymentMethodBrand
string

The brand of the payment method (e.g., 'Visa', 'Mastercard', 'Amex', 'PayPal').

payment.last4
string

The last four digits of the payment card, if applicable.

Example payload

json
{
  "eventId": "evt_1a2b3c4d-5e6f-7890-1234-567890abcdef",
  "orderId": "ord_a1b2c3d4-e5f6-7890-1234-567890abcdef",
  "timestamp": 1678886400,
  "type": "schedule_altered",
  "outstanding": "6250",
  "payment": {
    "id": "pay_x1y2z3a4-b5c6-7890-1234-567890abcdef",
    "currency": "GBP",
    "amount": 10000,
    "type": "manual",
    "status": "paid",
    "dueDate": 1678886400,
    "factDate": 1678886400,
    "lateFee": null,
    "orderId": "ord_a1b2c3d4-e5f6-7890-1234-567890abcdef",
    "paymentMethodBrand": "Visa",
    "last4": "4242"
  }
}
admin_adjusted_schedule
An administrator has adjusted the payment schedule.

Event object

eventId
string

Unique identifier for the order event.

orderId
string

The ID of the order this event belongs to. (References Order)

timestamp
integer

Unix timestamp of when the event occurred.

type
string

The type of order event.

outstanding
string

The outstanding amount at the time of the event, or a relevant note.

payment
object

Optional full payment object associated with this event. (References Payment)

Object properties:

payment.id
string
required

Unique identifier for the payment.

payment.currency
string

The currency of the payment (e.g., 'GBP').

payment.amount
integer
required

The amount of the payment in pence (or smallest currency unit).

payment.type
string
required

The type of payment (e.g., 'buy_in', 'scheduled').

payment.status
string
required

The current status of the payment.

payment.dueDate
integer
required

Unix timestamp of when the payment is due.

payment.factDate
integer

Unix timestamp of when the payment was actually made (if applicable).

payment.lateFee
integer

Any late fee applied to the payment in pence.

payment.orderId
string
required

The ID of the order this payment belongs to.

payment.paymentMethodBrand
string

The brand of the payment method (e.g., 'Visa', 'Mastercard', 'Amex', 'PayPal').

payment.last4
string

The last four digits of the payment card, if applicable.

Example payload

json
{
  "eventId": "evt_1a2b3c4d-5e6f-7890-1234-567890abcdef",
  "orderId": "ord_a1b2c3d4-e5f6-7890-1234-567890abcdef",
  "timestamp": 1678886400,
  "type": "admin_adjusted_schedule",
  "outstanding": "6250",
  "payment": {
    "id": "pay_x1y2z3a4-b5c6-7890-1234-567890abcdef",
    "currency": "GBP",
    "amount": 10000,
    "type": "manual",
    "status": "paid",
    "dueDate": 1678886400,
    "factDate": 1678886400,
    "lateFee": null,
    "orderId": "ord_a1b2c3d4-e5f6-7890-1234-567890abcdef",
    "paymentMethodBrand": "Visa",
    "last4": "4242"
  }
}
delinquent_notice_email
A delinquency notice email has been sent.

Event object

eventId
string

Unique identifier for the order event.

orderId
string

The ID of the order this event belongs to. (References Order)

timestamp
integer

Unix timestamp of when the event occurred.

type
string

The type of order event.

outstanding
string

The outstanding amount at the time of the event, or a relevant note.

payment
object

Optional full payment object associated with this event. (References Payment)

Object properties:

payment.id
string
required

Unique identifier for the payment.

payment.currency
string

The currency of the payment (e.g., 'GBP').

payment.amount
integer
required

The amount of the payment in pence (or smallest currency unit).

payment.type
string
required

The type of payment (e.g., 'buy_in', 'scheduled').

payment.status
string
required

The current status of the payment.

payment.dueDate
integer
required

Unix timestamp of when the payment is due.

payment.factDate
integer

Unix timestamp of when the payment was actually made (if applicable).

payment.lateFee
integer

Any late fee applied to the payment in pence.

payment.orderId
string
required

The ID of the order this payment belongs to.

payment.paymentMethodBrand
string

The brand of the payment method (e.g., 'Visa', 'Mastercard', 'Amex', 'PayPal').

payment.last4
string

The last four digits of the payment card, if applicable.

Example payload

json
{
  "eventId": "evt_1a2b3c4d-5e6f-7890-1234-567890abcdef",
  "orderId": "ord_a1b2c3d4-e5f6-7890-1234-567890abcdef",
  "timestamp": 1678886400,
  "type": "delinquent_notice_email",
  "outstanding": "6250",
  "payment": {
    "id": "pay_x1y2z3a4-b5c6-7890-1234-567890abcdef",
    "currency": "GBP",
    "amount": 10000,
    "type": "manual",
    "status": "paid",
    "dueDate": 1678886400,
    "factDate": 1678886400,
    "lateFee": null,
    "orderId": "ord_a1b2c3d4-e5f6-7890-1234-567890abcdef",
    "paymentMethodBrand": "Visa",
    "last4": "4242"
  }
}
delinquent_notice_message
A delinquency notice message (SMS, WhtatsApp) has been sent.

Event object

eventId
string

Unique identifier for the order event.

orderId
string

The ID of the order this event belongs to. (References Order)

timestamp
integer

Unix timestamp of when the event occurred.

type
string

The type of order event.

outstanding
string

The outstanding amount at the time of the event, or a relevant note.

payment
object

Optional full payment object associated with this event. (References Payment)

Object properties:

payment.id
string
required

Unique identifier for the payment.

payment.currency
string

The currency of the payment (e.g., 'GBP').

payment.amount
integer
required

The amount of the payment in pence (or smallest currency unit).

payment.type
string
required

The type of payment (e.g., 'buy_in', 'scheduled').

payment.status
string
required

The current status of the payment.

payment.dueDate
integer
required

Unix timestamp of when the payment is due.

payment.factDate
integer

Unix timestamp of when the payment was actually made (if applicable).

payment.lateFee
integer

Any late fee applied to the payment in pence.

payment.orderId
string
required

The ID of the order this payment belongs to.

payment.paymentMethodBrand
string

The brand of the payment method (e.g., 'Visa', 'Mastercard', 'Amex', 'PayPal').

payment.last4
string

The last four digits of the payment card, if applicable.

Example payload

json
{
  "eventId": "evt_1a2b3c4d-5e6f-7890-1234-567890abcdef",
  "orderId": "ord_a1b2c3d4-e5f6-7890-1234-567890abcdef",
  "timestamp": 1678886400,
  "type": "delinquent_notice_message",
  "outstanding": "6250",
  "payment": {
    "id": "pay_x1y2z3a4-b5c6-7890-1234-567890abcdef",
    "currency": "GBP",
    "amount": 10000,
    "type": "manual",
    "status": "paid",
    "dueDate": 1678886400,
    "factDate": 1678886400,
    "lateFee": null,
    "orderId": "ord_a1b2c3d4-e5f6-7890-1234-567890abcdef",
    "paymentMethodBrand": "Visa",
    "last4": "4242"
  }
}
admin_adjusted_amounts
An administrator has adjusted the amounts (e.g., total, outstanding) on the order.

Event object

eventId
string

Unique identifier for the order event.

orderId
string

The ID of the order this event belongs to. (References Order)

timestamp
integer

Unix timestamp of when the event occurred.

type
string

The type of order event.

outstanding
string

The outstanding amount at the time of the event, or a relevant note.

payment
object

Optional full payment object associated with this event. (References Payment)

Object properties:

payment.id
string
required

Unique identifier for the payment.

payment.currency
string

The currency of the payment (e.g., 'GBP').

payment.amount
integer
required

The amount of the payment in pence (or smallest currency unit).

payment.type
string
required

The type of payment (e.g., 'buy_in', 'scheduled').

payment.status
string
required

The current status of the payment.

payment.dueDate
integer
required

Unix timestamp of when the payment is due.

payment.factDate
integer

Unix timestamp of when the payment was actually made (if applicable).

payment.lateFee
integer

Any late fee applied to the payment in pence.

payment.orderId
string
required

The ID of the order this payment belongs to.

payment.paymentMethodBrand
string

The brand of the payment method (e.g., 'Visa', 'Mastercard', 'Amex', 'PayPal').

payment.last4
string

The last four digits of the payment card, if applicable.

Example payload

json
{
  "eventId": "evt_1a2b3c4d-5e6f-7890-1234-567890abcdef",
  "orderId": "ord_a1b2c3d4-e5f6-7890-1234-567890abcdef",
  "timestamp": 1678886400,
  "type": "admin_adjusted_amounts",
  "outstanding": "6250",
  "payment": {
    "id": "pay_x1y2z3a4-b5c6-7890-1234-567890abcdef",
    "currency": "GBP",
    "amount": 10000,
    "type": "manual",
    "status": "paid",
    "dueDate": 1678886400,
    "factDate": 1678886400,
    "lateFee": null,
    "orderId": "ord_a1b2c3d4-e5f6-7890-1234-567890abcdef",
    "paymentMethodBrand": "Visa",
    "last4": "4242"
  }
}
refund
A full or partial refund has been processed for the order.

Event object

eventId
string

Unique identifier for the order event.

orderId
string

The ID of the order this event belongs to. (References Order)

timestamp
integer

Unix timestamp of when the event occurred.

type
string

The type of order event.

outstanding
string

The outstanding amount at the time of the event, or a relevant note.

revisedReceipt
array

A revised receipt, representing a list of products, similar to a basket's product structure, if the basket/order was adjusted.

Array items contain:

revisedReceipt[].name
string
required

Name of the product.

revisedReceipt[].price
number
required

Price of the product.

revisedReceipt[].currency
string
required

Currency of the price (e.g., 'GBP', 'USD').

revisedReceipt[].vat
number

Value Added Tax percentage.

revisedReceipt[].qty
integer
required

Quantity of the product.

revisedReceipt[].discount
number

Discount applied to the product.

Example payload

json
{
  "eventId": "evt_1a2b3c4d-5e6f-7890-1234-567890abcdef",
  "orderId": "ord_a1b2c3d4-e5f6-7890-1234-567890abcdef",
  "timestamp": 1678886400,
  "type": "refund",
  "outstanding": "6250",
  "revisedReceipt": [
    {
      "name": "Product X",
      "price": 5000,
      "currency": "GBP",
      "vat": 20,
      "qty": 1,
      "discount": 0
    },
    {
      "name": "Product Y",
      "price": 5000,
      "currency": "GBP",
      "vat": 20,
      "qty": 1,
      "discount": 0
    }
  ]
}
admin_adjusted_basket
An administrator has adjusted the items in the order's basket/receipt.

Event object

eventId
string

Unique identifier for the order event.

orderId
string

The ID of the order this event belongs to. (References Order)

timestamp
integer

Unix timestamp of when the event occurred.

type
string

The type of order event.

outstanding
string

The outstanding amount at the time of the event, or a relevant note.

revisedReceipt
array

A revised receipt, representing a list of products, similar to a basket's product structure, if the basket/order was adjusted.

Array items contain:

revisedReceipt[].name
string
required

Name of the product.

revisedReceipt[].price
number
required

Price of the product.

revisedReceipt[].currency
string
required

Currency of the price (e.g., 'GBP', 'USD').

revisedReceipt[].vat
number

Value Added Tax percentage.

revisedReceipt[].qty
integer
required

Quantity of the product.

revisedReceipt[].discount
number

Discount applied to the product.

Example payload

json
{
  "eventId": "evt_1a2b3c4d-5e6f-7890-1234-567890abcdef",
  "orderId": "ord_a1b2c3d4-e5f6-7890-1234-567890abcdef",
  "timestamp": 1678886400,
  "type": "admin_adjusted_basket",
  "outstanding": "6250",
  "revisedReceipt": [
    {
      "name": "Product X",
      "price": 5000,
      "currency": "GBP",
      "vat": 20,
      "qty": 1,
      "discount": 0
    },
    {
      "name": "Product Y",
      "price": 5000,
      "currency": "GBP",
      "vat": 20,
      "qty": 1,
      "discount": 0
    }
  ]
}
support_ticket_created
A new support ticket related to the order has been created.

Event object

eventId
string

Unique identifier for the order event.

orderId
string

The ID of the order this event belongs to. (References Order)

timestamp
integer

Unix timestamp of when the event occurred.

type
string

The type of order event.

outstanding
string

The outstanding amount at the time of the event, or a relevant note.

supportTicketId
string

Optional ID of a support ticket associated with this event. (References SupportTicket)

Example payload

json
{
  "eventId": "evt_1a2b3c4d-5e6f-7890-1234-567890abcdef",
  "orderId": "ord_a1b2c3d4-e5f6-7890-1234-567890abcdef",
  "timestamp": 1678886400,
  "type": "support_ticket_created",
  "outstanding": "6250",
  "supportTicketId": null
}
support_ticket_update
A support ticket related to the order has been updated.

Event object

eventId
string

Unique identifier for the order event.

orderId
string

The ID of the order this event belongs to. (References Order)

timestamp
integer

Unix timestamp of when the event occurred.

type
string

The type of order event.

outstanding
string

The outstanding amount at the time of the event, or a relevant note.

supportTicketId
string

Optional ID of a support ticket associated with this event. (References SupportTicket)

Example payload

json
{
  "eventId": "evt_1a2b3c4d-5e6f-7890-1234-567890abcdef",
  "orderId": "ord_a1b2c3d4-e5f6-7890-1234-567890abcdef",
  "timestamp": 1678886400,
  "type": "support_ticket_update",
  "outstanding": "6250",
  "supportTicketId": null
}
support_ticket_resolved
A support ticket related to the order has been resolved.

Event object

eventId
string

Unique identifier for the order event.

orderId
string

The ID of the order this event belongs to. (References Order)

timestamp
integer

Unix timestamp of when the event occurred.

type
string

The type of order event.

outstanding
string

The outstanding amount at the time of the event, or a relevant note.

supportTicketId
string

Optional ID of a support ticket associated with this event. (References SupportTicket)

Example payload

json
{
  "eventId": "evt_1a2b3c4d-5e6f-7890-1234-567890abcdef",
  "orderId": "ord_a1b2c3d4-e5f6-7890-1234-567890abcdef",
  "timestamp": 1678886400,
  "type": "support_ticket_resolved",
  "outstanding": "6250",
  "supportTicketId": null
}