Payments

This is the payload of the Payment-type:

{
  "eventID": "d46f1727-e9a7-48f0-b2f9-53fe4cc9a2a5",
  "createTime": "2024-03-09 11:53:12.743",
  "type": "payment", // This "type"-property is deprecated, it will be removed later
  "objectName": "payment",
  "eventType": "Charged",
  "payload": {
    "payment": {
      "paymentCreated": {...}
      "customer": {...}
      "paymentInstructions": {...}
      "kidNorwayInvoice": {...}
      "moneySplit": {...}
      "ledger": {...}
      "metaData": {...}
    }
    // When receiving a payload from the payments webhookSubscriptions, 
    // you will also get the properties below, do not use these as they
    // are deprecated. Use the payment-properties instead as they
    // are the same.
    "paymentCreated": {...}
    "customer": {...}
    "paymentInstructions": {...}
    "kidNorwayInvoice": {...}
    "moneySplit": {...}
    "ledger": {...}
    "metaData": {...}
  }
}

Payments webhook endpoints

A payments webhook functionality is a little more elaborate than our Connected Account-webhook. In i payments intent you can specify a “webhookSubscriptions”-property with a list of additional endpoints and their event triggers. It is very important to note that properties specified here will send webhooks to this endpoint, as well as to the catchAll-endpoint defined in the Platform Dashboard.

{
  // ... other payment intent create properties
  "webhookSubscriptions": [
    {
      // Here we want an additional webhook sent to this endpoint for special handling.
      "eventType": "Charged",
      "url": "https://example.com/webhook/payment-charged"
    }
  ],
}

To see the full list of event types that can be listened to you can refer to our API References PaymentWebhookSubscriptions-model.

See the GetPaymentIntentDtoResponse-object from the API-reference for the full object and it’s values.