Added in MplusKASSA v11.3.0
Explanation of the event
The startExternalPayment event occurs whenever a external payment method is selected as a payment option.
Part of the External Payment flow
The startExternalPayment event is step one in a multi-step flow that involves the following events: (1) startExternalPayment, (2) pollExternalPayment, (3) requestCancelExternalPayment and (4) cancelExternalPayment.
startExternalPayment A new external payment was started
request
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 |
POST https://www.example.com/webhooks/startExternalPayment X-Mplus-Subscription-Id: example_subscription X-Mplus-Signature: ... Content-Type: application/json Accept: application/json { "externalPayment": { "externalPaymentId": "67d8b45a-37bd-4885-b41a-ffb285720654", "amount": 2.7, "method": "K_WEBHOOK" }, ... } |
| Property | Type | Explanation |
|---|---|---|
| externalPayment.amount | number | The amount that has to be paid |
| externalPayment.externalPaymentId | uuid | Each external payment receives a new id. |
| externalPayment.method | string | The name of the payment method that was configured to trigger the webhook. |
response
|
1 2 3 4 5 6 7 8 |
X-Mplus-Signature: uZucqk+xPZii7TmP1IHOKPoS4/K+8ejNwl7EyxnEzs4= Content-Type: application/json { "externalPayment": { "started": true } } |
| Property | Type | Explanation |
|---|---|---|
| externalPayment.started | boolean | The external payment was started |
Voor het gebruik van deze call dienen er financiële afspraken gemaakt te worden met MplusKASSA.