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 Zid Payments. After processing the refund, we expect refund Id and refund reference to be returned back in the response. Also, a webhook shall be sent to notify Zid Payments with success or failure result.

Request

Path Params

Header Params

Body Params application/json

Examples

Responses

🟢200OK

application/json

Bodyapplication/json

🟠400Bad Request

🟠401Unauthorized

🔴500Internal Server error

Request Example

Shell

JavaScript

Java

Swift

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

Response Example

200 - Example 1

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

Modified at 2026-01-30 20:55:20

Providing Merchant Validation

Overview