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

Example

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

Request Code 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 '{
    "paymentId": "pay_abc123xyz",
    "amount": 5000
}'

Responses

🟢200OK

application/json

Body

Example

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

🟠400Bad Request

Modified at 2025-08-06 13:45:53

Providing Merchant Validation

Overview