Payment Events

Trigger

• Description: Sent when a payment status changes (for example, when it is settled, voided, or refunded).

Payload

• createdAt: Unix epoch timestamp indicating when the event was created.

• type: Always 'PAYMENT' for this webhook.

• pspMerchantAccountName: The name of the parent Adyen merchant account.

• merchantAccountId: Unique ID for the merchant account.

• organizationId: Unique ID for the organization.

• status: Payment status. Common values include:

  • AUTHORIZED
  • SETTLED
  • VOIDED
  • PARTIALLY_REFUNDED
  • REFUNDED
  • DISPUTED

  A payment may also report intermediate lifecycle statuses such as PENDING, CAPTURE_REQUESTED, VOID_REQUESTED, REFUND_REQUESTED, and PARTIAL_REFUND_REQUESTED. Handle unknown values defensively.

• referenceId: The referenceId you sent when starting the checkout with the Checkout API.

• pspReferenceId: The payment service provider reference for the payment.

• source: The payment source (for example, ECOMMERCE).

• 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 tip amount in minor units, if applicable.

• surchargeAmount: The surcharge applied to the payment in minor units, if any.

• processingCost: Total processing cost associated with the transaction, in minor units, i.e. Interchange, Scheme, Adyen fees, etc. Not available 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 before the payment is SETTLED.

• currency: ISO currency code (e.g., 'USD', 'EUR').

• paymentMethod: The method used for the payment.

• paymentMethodVariant: Payment method variant.

• additionalData: An object containing extra card details: cardSummary (the last four digits) and expiryDate.

• checkoutCustomAttributes: Custom attributes that were specified in the Start Checkout API request.

Example

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