Payment Paid Event

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

curl --location --request POST 'https://api.zid.sa/v1/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" } } }'

Request

Header Params

Authorization

string

optional

All secured endpoints require an Authorization header using Basic Authentication. The value should be the secret key provided to the payment provider during integration.

Example:

Authorization: Basic secret_key

Body Params application/json

Webhook payload for notifying ZidPay of a payment status update.

type

string

required

Type of the webhook event.

Example:

payment_paid

thirdPartyId

integer

required

Unique ID assigned to the payment provider by ZidPay.

Example:

merchantId

string

required

Merchant's ID on the provider side.

Example:

45cb5978-c6cd-4e34-bd93-de6bee9b3cae

data

object

required

Payment status update details.

string

required

Payment ID on the provider side.

Example:

pay_abc123xyz

status

enum<string>

required

Status of the payment.

Allowed values:

paidfailed

Example:

paid

Examples

Payment Paid Event

Request

Responses