Integraties - Webhooks

Je kan Peggy Pay koppelen met je eigen software middels webhooks en onze PHP SDK.

In dit artikel worden de webhooks kort beschreven. Informatie over de PHP SDK kan je vinden op de github pagina.

Deze pagina en webhooks is nog in ontwikkeling/uitbreiding.

Webhooks kan je instellen in de editor onder de tab [Instellingen] => [Webhooks]. Hiervoor moet je wel de ontwikkelaarsmodus aanzetten middels het tandwieltje bovenin de toolbar:

Ontwikkelaarsmodus

Peggy Pay biedt de volgende webhooks:

De ingestelde url wordt aangeroepen met een dataset. Hieronder kan je lezen welke dataset bij welk event wordt meegestuurd.

Zorg ervoor dat de response altijd het volgende JSON-format heeft:

{
    "success" => true,
    "message" => "Custom message"
}

In "message" kan je een bericht zetten die je in de logs terug kan lezen.

Als er "success" iets anders is dan true, wordt de webhook opnieuw uitgevoerd met de volgende intervals:

2min, 2min, 5min, 10min, 20min, 30min, 1 uur, 2 uur, 4 uur, 8 uur en 24 uur.

Daarna stopt Peggy Pay met pogingen.

{
    "Id": string,
    "firstname-value": string,
    "lastname-value": string,
    "email-value": string,
    "payment-paymentStatus": "complete",
    "payment-paymentAmount": decimal (10, in euros),
    "payment-paymentAmountEx": decimal (8.26, in euros),
    "payment-paymentAmountVat": decimal (1.74, in euros),
    "dateAdded": string (YYYY-MM-DD HH:SS:ii),
    "orderNumber": string,
    "submissionStatus": "Nieuw",
    "formName": string,
    "formKey": string,
    "paymentType": string (subscription/installment/default),
    "paymentId": string (mollie payment Id)
    "submissionHash": string     
    "event": "newSubmission"
-- for subscription
    "subscriptionHash": string,
    "subscriptionInterval": string (daily/weekly/monthly etc),
    "subscriptionAmount": int (5000, in cents),
    "subscriptionAmountEx": int,
    "subscriptionCustomerId": string,
    "subscriptionSubscriptionId": string,
-- for installment
    "totalTerms": int,
}

{
    "userName": string,
    "email": string,
    "dateAdded": string (YYYY-MM-DD HH:SS:ii),
    "name": string,
    "title": string,
    "amount": int (5000, in cents),
    "amountEx": int,
    "vat": int (tax rate, 21 for 21%, 9 for 9% etc)
    "vatAmount": int,
    "orderNumber": string,
    "hash": string,
    "submissionHash": string
}

{
    "status": {
        "name": string (new, incomplete, complete, reviewed, archived, pending, cancelled, shipped, authorized, refunded, processing, readyForShipment, cashback, refundedPartially)
        "title": string,
        "isActive": 1 or 0,
        "isComplete": 1 or 0,
        "isReviewed": 1 or 0
    },
    "submissions": [
        {
            "orderNr": string,
            "orderNrFormatted": string,
            "submissionHash": string,
        },
        ..
    ]
}

Geldt voor zowel installmentPayment als voor installmentPaymentFailed

{
    "paymentId": string,
    "term": int,
    "submissionHash": string,
    "amount": int (5000, in cents),
    "amountEx": int,

    "installmentCustomerId": string (mollie customer id),
    "installmentSubscriptionId": string (mollie subscription id),

    "paymentType": string (installent / installentRetry),
-- in case of failed
    "reason": string
}

Geldt voor subscriptionPayment en subscriptionPaymentFailed

{
    "formKey": string,
    "paymentId": string (mollie payment id),

    "userName": string,
    "userEmail": string,

    "subscriptionTrialAmount": int (5000, in cents),
    "subscriptionTrialPeriod": string (days, weeks etc),
    "subscriptionTrialInterval": int,

    "submissionHash": string,
    "dateAdded": string (YYYY-MM-DD HH:SS:ii),

    "subscriptionAmount": int (5000, in cents),
    "subscriptionAmountEx": int,
    "subscriptionCustomerId": string (mollie customer id),
    "subscriptionSubscriptionId": string (mollie subscription id),
    "subscriptionDescription": string,
    "subscriptionRecurringInterval": string (weekly, monthly etc),
    "subscriptionHash": string,

    "incVat": 1 or 0,
    "vatAmount": int (5000, in cents)

    "amount": int,
    "amountEx": int,
-- for failed
    "reason": string
}

Geldt voor subscriptionCancelledByCustomer en subscriptionCancelledByOwner

{
    "formKey": string,

    "userName": string,
    "userEmail": string,

    "subscriptionTrialAmount": int (5000, in cents),
    "subscriptionTrialPeriod": string (days, weeks etc),
    "subscriptionTrialInterval": int,

    "submissionHash": string,
    "dateAdded": string (YYYY-MM-DD HH:SS:ii),

    "subscriptionAmount": int (5000, in cents),
    "subscriptionAmountEx": int,
    "subscriptionCustomerId": string (mollie customer id),
    "subscriptionSubscriptionId": string (mollie subscription id),
    "subscriptionDescription": string,
    "subscriptionRecurringInterval": string (weekly, monthly etc),
    "subscriptionHash": string,

    "incVat": 1 or 0,
    "vatAmount": int (5000, in cents)

    "cancelType": string (cancelled, cancelledEndOfPeriod, finalEndOfPeriod*),
    "cancelledBy": string (customer, owner)
}

Cancel type