Webhook event types

Weebhook event types reference

List of event types

The list of webhook event types must be retrieve with API merchant-webhooks/api/v1/event-types

The list of webhook event types depends of the you've subscribed.

Solution e-financing event types

2 event types: - SC_SUBSCRIPTION : all events related to a status change - SC_CANCEL_REQUEST: all events related to a cancel request

eventTypeCode

EventCode

Description

SC_SUBSCRIPTION

SC_SUBSCRIPTION_INITIALIZED

occurs whenever a subscription is initialized

SC_SUBSCRIPTION_PRE_ACCEPTED

occurs whenever a subscription is pre-accepted

SC_SUBSCRIPTION_ACCEPTED

occurs whenever a subscription is accepted

SC_SUBSCRIPTION_REJECTED

occurs whenever a subscription is rejected

SC_SUBSCRIPTION_CANCELLED

occurs whenever a subscription is cancelled

SC_SUBSCRIPTION_ABORTED

occurs whenever a subscription is aborted

SC_CANCEL_REQUEST

SC_CANCEL_REQUEST_CANCELLATION_ACCEPTED

occurs whenever a full cancellation is accepted

SC_CANCEL_REQUEST_CANCELLATION_REJECTED

occurs whenever a full cancellation is rejected

SC_CANCEL_REQUEST_PARTIAL_CANCELLATION_ACCEPTED

occurs whenever a partial cancellation is accepted

SC_CANCEL_REQUEST_PARTIAL_CANCELLATION_REJECTED

occurs whenever a partial cancellation is rejected

Solution insurance event types

1 event type: - CI_SUBSCRIPTION: all events related to status change

eventTypeCode

eventCode

Description

CI_SUBSCRIPTION

CI_SUBSCRIPTION_SUBSCRIBED

occurs whenever a subscription is subscribed

CI_SUBSCRIPTION_REJECTED

occurs whenever a subscription is rejected

CI_SUBSCRIPTION_CANCELLED

occurs whenever a subscription is cancelled

CI_SUBSCRIPTION_ABORTED

occurs whenever a subscription is aborted

Example of response of API merchant-webhooks/api/v1/event-types

Response of API merchant-webhooks/api/v1/event-types

{

    "eventTypes": [

        {

            "eventTypeCode": "SC_SUBSCRIPTION",

            "description": "All status updates related to a credit subscription",

            "eventCodes": [

                {

                    "eventCode": "SC_SUBSCRIPTION_INITIALIZED",

                    "description": "Occurs whenever a credit subscription is initialized"

                },

                {

                    "eventCode": "SC_SUBSCRIPTION_PRE_ACCEPTED",

                    "description": "Occurs whenever a credit subscription is pre-accepted"

                },

                {

                    "eventCode": "SC_SUBSCRIPTION_ACCEPTED",

                    "description": "Occurs whenever a credit subscription is accepted"

                },

                {

                    "eventCode": "SC_SUBSCRIPTION_REJECTED",

                    "description": "Occurs whenever a credit subscription is rejected"

                },

                {

                    "eventCode": "SC_SUBSCRIPTION_CANCELLED",

                    "description": "Occurs whenever a credit subscription is cancelled"

                },

                {

                    "eventCode": "SC_SUBSCRIPTION_ABORTED",

                    "description": "Occurs whenever a credit subscription is aborted"

                }

            ]

        },

        {

            "eventTypeCode": "SC_CANCEL_REQUEST",

            "description": "All status updates related to a credit cancellation request (total or partial cancellation)",

            "eventCodes": [

                {

                    "eventCode": "SC_CANCEL_REQUEST_CANCELLATION_ACCEPTED",

                    "description": "Occurs whenever a credit total cancellation request is accepted"

                },

                {

                    "eventCode": "SC_CANCEL_REQUEST_CANCELLATION_REJECTED",

                    "description": "Occurs whenever a credit total cancellation request is rejected"

                },

                {

                    "eventCode": "SC_CANCEL_REQUEST_PARTIAL_CANCELLATION_ACCEPTED",

                    "description": "Occurs whenever a credit partial cancellation request is accepted"

                },

                {

                    "eventCode": "SC_CANCEL_REQUEST_PARTIAL_CANCELLATION_REJECTED",

                    "description": "Occurs whenever a credit partial cancellation request is rejected"

                }

            ]

        },

        {

            "eventTypeCode": "CI_SUBSCRIPTION",

            "description": "All status updates related to an insurance subscription",

            "eventCodes": [

                {

                    "eventCode": "CI_SUBSCRIPTION_SUBSCRIBED",

                    "description": "Occurs whenever an insurance is subscribed"

                },

                {

                    "eventCode": "CI_SUBSCRIPTION_REJECTED",

                    "description": "Occurs whenever an insurance is rejected"

                },

                {

                    "eventCode": "CI_SUBSCRIPTION_CANCELLED",

                    "description": "Occurs whenever an insurance is cancelled"

                },

                {

                    "eventCode": "CI_SUBSCRIPTION_ABORTED",

                    "description": "Occurs whenever an insurance is aborted"

                }

            ]

        }

    ]

}

Solution Marketplace Services event types

MP types are related to Marketplace Services . all events related to status change

eventTypeCode

eventCode

Description

MP_SELLER_ONBOARDING

MP_IBAN_AVAILABLE_FOR_PAYMENT

occurs whenever the IBAN for the 1€ payment is available for seller

MP_SELLER_ONBOARDING

MP_KYC_IN_PROGRESS

occurs whenever the kyc assessment is ongoing for a seller

MP_SELLER_ONBOARDING

MP_KYC_VALIDATED

occurs whenever the kyc is approved for a seller

MP_SELLER_ONBOARDING

MP_KYC_REFUSED

occurs whenever the kyc is refused and needs corrections

MP_ORDER

MP_ORDER_NOT_FOUND

Occurs whenever a transaction reference a merchantGlobalOrderId not found by marketplace services

MP_TRANSFER

MP_TRANSFER_UPDATE

occurs whenever the transfer status change

MP_TRANSACTION

MP_TRANSACTION_UPDATE

occurs whenever the transaction status change

MP_PAYOUT_MERCHANT

MP_PAYOUT_MERCHANT_UPDATE

occurs whenever the payoutMerchant status change

MP_PAYOUT_SELLER

MP_PAYOUT_SELLER_UPDATE

occurs whenever the payoutSeller status change

Payload of an event types

You can find the documentation embedded in the API GET merchant-webhooks/api/v1/events.

The "data" structure depends of "eventTypeCode" attribute. You can parse the response depending the content of "eventTypeCode" ("SC_SUBSCRIPTION", "SC_CANCEL_REQUEST", "CI_SUBSCRIPTION", HELLO_WORLD" ...)

Here is an exemple of a payload of event on e-Financing subscriptions object when status code is set to "PRE_ACCEPTED" meaning the subscription is pending final back-office financial institution.

{
      "timestamp": "2023-06-27T13:20:30.456Z",
      "id": "44f5060e-a89c-11ed-afa1-0242ac120002",
      "correlationId": "7d9670fe-a0cf-4073-afde-bdc61ca49f75",
      "eventTypeCode": "SC_SUBSCRIPTION",
      "eventCode": "SC_SUBSCRIPTION_PRE_ACCEPTED",
      "data": {
        "eventTypeCode": "SC_SUBSCRIPTION",
        "eventCode": "SC_SUBSCRIPTION_PRE_ACCEPTED",
        "merchantGlobalOrderId": "MYORDER-12345",
        "financedAmount": 500.00,
        "consolidatedStatus": "PRE_ACCEPTED"
      }
}

Event types "SC_SUBSCRIPTION"

Concern only the "e-financing" solutions and events related to status of credit subscriptions .

Payload SC_SUBSCRIPTION

    ScSubscriptionPayload:
      required:
        - eventTypeCode
      type: object
      properties:
        eventTypeCode:
          type: string
        eventCode:
          type: string
        merchantGlobalOrderId:
          type: string
        financedAmount:
          type: number
          format: float
        consolidatedStatus:
          type: string
          description: Current status of the buyer (final customer) credit subscription

Event types "SC_CANCEL_REQUEST"

Concern only the "e-financing" solutions and events related to cancellations requests status.

Payload SC_CANCEL_REQUEST

    ScCancelRequestPayload:
      required:
        - eventTypeCode
      type: object
      properties:
        eventTypeCode:
          type: string
        eventCode:
          type: string
        merchantGlobalOrderId:
          type: string
        cancelledAmount:
          type: number
          format: float
        financedAmount:
          type: number
          format: float
        consolidatedStatus:
          type: string
          description: Current status of the buyer (final customer) credit subscription
        cancellationStatus:
          type: string
          enum:
            - REQUEST_FOR_PARTIAL_CANCELLATION
            - REQUEST_FOR_CANCELLATION
            - CANCELLATION_ACCEPTED
            - CANCELLATION_REJECTED
            - PARTIAL_CANCELLATION_ACCEPTED
            - PARTIAL_CANCELLATION_REJECTED

Event types "CI_SUBSCRIPTION"

Concern only the "insurance" solutions and events related to subscription status.

Payload CI_SUBSCRIPTION

    CiSubscriptionPayload:
      required:
        - eventTypeCode
      type: object
      properties:
        eventTypeCode:
          type: string
        eventCode:
          type: string
        merchantGlobalOrderId:
          type: string
        insuranceSubscriptionId:
          type: string
        consolidatedStatus:
          type: string
          description: Current status of the buyer (final customer) insurance subscription
          enum:
            - INITIALIZED
            - SUBSCRIBED
            - ACTIVATED
            - CANCELLED
            - TERMINATED
            - ABORTED
            - REJECTED

Event types "HELLO_WORLD"

This event type is only for testing purpose to enable testing you merchant configuration.

Payload HELLO_WORLD

    WebhookPayloadForHelloWorld:
      required:
        - eventTypeCode
        - helloWorldMessage
      type: object
      properties:
        eventTypeCode:
          type: string
        eventCode:
          type: string
        helloWorldMessage:
          type: string
          description: Hello World message
          example: Hello World !
      description: >-
        Payload of the HelloWorld event used to test the webhooks feature on the
        merchant side (to test end-to-end connec

PreviousV 1.0.6 - Merchant Webhooks API NextWebhook error codes

Last updated 4 months ago

Was this helpful?