Ask something in the search bar to get a quick answer from our AI model
General Doc

API - Refund

Request partial or full refund

  1. POST {BASE_URL}/wipay-payment-admin/v2/refund

This endpoint creates a refund operation to fully or partially reverse a previously completed transaction. The system automatically determines whether the requested amount qualifies as a full refund or a partial cancellation.

Headers

Name
Value

Content-Type

application/json

X-Api-Key

API Key <xxx>

Body # 1

Type
Name
Description
Conditions

string

requestId

Unique link identifier

Required

string

merchantId

Unique merchat identifier

Required

number

amount

Total operation amount

Required

string

terminalId

Unique merchant terminal identifier. If your merchant account has multiple terminals, you must specify the terminal ID to indicate which one to use. If you have only one terminal, you may omit this field—it will default to the only available terminal.

Optional

string

reference

Unique identifier that links the refund with the executed payment. This is the reference of the original transaction to be refunded, typically obtained through the online confirmation or payment response.

Required

string

merchantOperationId

Optional field that you can use in order to identify operations in your system (is gonna be returned in the WebHook communication)

Optional

Request

{
    "requestId": "9803452372-25-0-P4IoJhO9BWQreslB3fyXKnnr",
    "merchantId": "123456",
    "amount": 1.00,
    "currency": "234",
    "terminalId": "00045566",
    "reference": "009996114453312"
}

Full refund: If amount equals the original transaction total, the system processes a full refund. Partial cancellation: If amount is less than the total, it’s treated as a partial refund (allowing multiple partial operations as long as the cumulative amount does not exceed the original).

Responses

PreviousQuery transactions by user and date rangeNextAPI - Pay with Token

Last updated