Payment Paid Event

POST

https://api.zid.sa//api/webhook/v1/thirdpartywebhook

The "Payment Paid Event" is used to notify Zid Payments system of any updates regarding the status of a payment, whether it is successful or failed. This ensures that Zid Payments is informed about the payment status and can update its records accordingly.

Request

Header Params

Body Params application/json

Example

{
    "type": "object",
    "example": {
        "type": "payment_paid",
        "thirdPartyId": 1,
        "merchantId": "45cb5978-c6cd-4e34-bd93-de6bee9b3cae",
        "data": {
            "id": "pay_abc123xyz",
            "status": "paid"
        }
    }
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.zid.sa//api/webhook/v1/thirdpartywebhook' \
--header 'Authorization: Authorization: Basic secret_key' \
--header 'Content-Type: application/json' \
--data-raw '{
    "type": "object",
    "example": {
        "type": "payment_paid",
        "thirdPartyId": 1,
        "merchantId": "45cb5978-c6cd-4e34-bd93-de6bee9b3cae",
        "data": {
            "id": "pay_abc123xyz",
            "status": "paid"
        }
    }
}'

Responses

🟢200Success

application/json

Body

Example

{}

Modified at 2025-08-06 14:00:38

Link Merchant Event

Refund Event