Payment Event Webhooks

Trigger

• Description: Sent when a payment status changes (e.g., settled, void, etc.).

Payload

• createdAt: Unix epoch timestamp indicating when the event was created.
• type: Always 'PAYMENT' for this webhook.
• merchantAccountId: Unique ID for the merchant account.
• organizationId: Unique ID for the organization.
• status: Payment status, can be one of:
  • AUTHORIZED
  • SETTLED
  • VOID
  • PARTIALLY_REFUNDED
  • REFUNDED
  • DISPUTED
• referenceId: Unique payment reference ID, as provided in the initiate payment link API request.
• authorizedAmount: The amount authorized for the payment in minor units.
• merchantAmount: The amount to be paid to the merchant if applicable in minor units. Not available before the payment is SETTLED.
• fees: Fees associated with the transaction in minor units, if applicable.
• tipAmount: The amount of the tip, if applicable.
• processingCost: Total processing cost associated with the transaction, in minor units, i.e. Interchange, Scheme, Adyen fees, etc. Not available when using merchant-specific webhooks and before the payment is SETTLED.
• profit: Resulting profit for the transaction, in minor units: total fees collected from the transaction minus processing cost. Not available when using merchant-specific webhooks and before the payment is SETTLED.
• currency: ISO currency code (e.g., 'USD', 'EUR').
• paymentMethod: The method used for the payment.
• paymentMethodVariant: Payment method variant.
• checkoutCustomAttributes: Custom attributes that were specified in the Start Checkout API request.

Example

{
  "createdAt": 1697339133,
  "merchantAccountId": "12bb40d2-94ee-494c-a5d7-4b6f29428491",
  "organizationId": "bf368afb-ed57-4345-a04a-7c7213431a99",
  "referenceId": "bfcb6c55-e999-4d14-9db9-3274718da226",
  "pspReferenceId": "D2JBV9K7PMNGZG65",
  "authorizedAmount": 97813,
  "merchantAmount": 94879,
  "fees": 2934,
  "processingCost": 1192,
  "profit": 1742,
  "currency": "USD",
  "paymentMethod": "visa",
  "paymentMethodVariant": "visadebit",
  "source": "ECOMMERCE",
  "status": "SETTLED",
  "type": "PAYMENT",
  "checkoutCustomAttributes": {
    "CUSTOM_ATTRIBUTE": "CUSTOM_ATTRIBUTE_VALUE"
  }
}