Request Refund

POST

https://api.zid.sa/{ProviderUrl}/refund

When a refund is requested from a customer the following request will be sent to the payment provider From ZidPay, if this is a success then a refund webhook should be sent to ZidPay

Request

Path Params

Header Params

Body Params application/json

Example

{
    "amount": 5000,
    "paymentId": "pay_abc123xyz"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.paymentprovider.com/refund' \
--header 'Authorization: Authorization: Basic secret_key' \
--header 'Content-Type: application/json' \
--data-raw '{
    "amount": 5000,
    "paymentId": "pay_abc123xyz"
}'

Responses

🟢200OK

application/json

Body

Example

{
    "refundId": "9f4b5fa0-bd22-40e4-b3ad-e6742f37a102",
    "refundReference": "f781d5fa-9e8d-49b5-92a2-37321d5c8c4f",
    "status": "Refunded"
}

Modified at 2025-05-27 08:29:04

On Providing Merchant Validation