Themes built on the Twig templating engine are now deprecated and require migration to Vitrin to ensure continued support and compatibility with Zid.

Upload bank transfer receipt

Developing

POST

https://api.zid.sa//v1/managers/store/reverse-orders/refund/upload-bank-receipt

Uploads a bank transfer receipt for a refund that was created using the
zid_bank_transfer payment method.

This endpoint is used after a refund has already been created via:

POST /v1/managers/store/reverse-orders/refund

It associates the uploaded receipt file with the refund and updates the related reverse order.

⚠️ Important

This endpoint is mandatory when the refund payment method is zid_bank_transfer.

Only image files are supported.

The refund must already exist.

Request

Header Params

Body Params multipart/form-dataRequired

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.zid.sa//v1/managers/store/reverse-orders/refund/upload-bank-receipt' \
--header 'Authorization: {{Autherization}}' \
--header 'Access-Token: {{Access-Token}}' \
--header 'Accept-Language: en' \
--form 'refund_id="f3a9b2d4-92f7-4d1b-a123-abc123456789"' \
--form 'bank_transfer_receipt=@""'

Responses

🟢200Success

application/json

Body

Example

{
    "data": {
        "order_reverse": {
            "id": "550e8400-e29b-41d4-a716-446655440000",
            "refund": {
                "id": "f3a9b2d4-92f7-4d1b-a123-abc123456789",
                "payment_method": "zid_bank_transfer",
                "amount": 100.5,
                "bank_transfer_receipt": "https://cdn.zid.store/refunds/receipt_12345.png",
                "status": "processing"
            }
        }
    }
}

🟠401Unauthorized

🔴500Internal Server error

Modified at 2026-02-02 08:14:00

Create refund for reverse order

Update return products

Upload bank transfer receipt

⚠️ Important#

Request

Request Code Samples

Responses

⚠️ Important