Create webhook subscription

Production Environment

https://api.lopay.com

POST

/api/1/partner/webhooks

Webhook subscriptions

Request

Authorization

Add parameter in header

x-api-key

Example:

x-api-key: ********************

Body Params application/json

events

array[string]

required

Allowed values:

merchant.capabilities.updatedmerchant.payout.createdmerchant.payout.paidmerchant.payout.cancelledmerchant.payout.failedpayment.successpayment.failedpaymentLink.createdpaymentLink.updatedpaymentLink.revoked

url

string <uri>

required

merchantIds

array[string <uuid>] | null

optional

<= 1 items

Examples

Subscribe to payment success and payment failure eventsSubscribe only events for certain merchant IDs

{
    "events": [
        "payment.success",
        "payment.failed"
    ],
    "url": "https://api.example/webhooks/lopay"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

cURL

Subscribe to payment success and payment failure eventsSubscribe only events for certain merchant IDs

curl --location --request POST 'https://api.lopay.com/api/1/partner/webhooks' \
--header 'Content-Type: application/json' \
--header 'x-api-key;' \
--data-raw '{
    "events": [
        "payment.success",
        "payment.failed"
    ],
    "url": "https://api.example/webhooks/lopay"
}'

Responses

🟢201Created

application/json

Created response

Body

string

required

events

array[string]

required

Allowed values:

url

string <uri>

required

webhookSecretKey

string

required

Example

{
    "id": "ep_1srOrx2ZWZBpBUvZwXKQmoEYgab",
    "events": [
        "payment.success",
        "payment.failed"
    ],
    "url": "https://api.example/webhooks/lopay",
    "webhookSecretKey": "whsec_YXDKaykd6oBK7J/hrFqstWuFfAxbVFSl"
}

🟠400Bad Request

🟠401Unauthorized

Modified at 2025-06-04 16:00:16

List webhook subscriptions

Update existing webhook subscription