Refund

Refund

POST/pay/trade/refund

Submit a full or partial refund request for a paid order. This endpoint does not require authentication.

SDK methodrefund()

ParametersRequest body

pay_memberidstringrequired

SDK property: payMemberid. Merchant ID

transaction_idstringrequired

SDK property: transactionId. Platform transaction ID

pay_orderidstringrequired

SDK property: payOrderid. Merchant order number

currencystringrequired

Order currency

pay_amountstringrequired

SDK property: payAmount. Original order amount

refund_amountstringrequired

SDK property: refundAmount. Refund amount (partial supported)

refund_reasonstringrequired

SDK property: refundReason. Refund reason

pay_md5signstringrequiredsign

SDK property: payMd5Sign. MD5 signature

Response

**200** — `PayTradeRefundResponse` via `getResult()`.

POST/pay/trade/refund

use JPayApiLib\Models\Requests\Builders\RefundRequestBuilder;

$request = RefundRequestBuilder::init()
    ->payMemberid('10153')
    ->transactionId('346874883747')
    ->payOrderid('O20260101001')
    ->currency('USD')
    ->refundAmount('10.00')
    ->refundReason('Customer request')
    ->payMd5Sign('YOUR_MD5_SIGN')
    ->build();

$apiResponse = $client->getPaymentsApi()->refund($request);

if ($apiResponse->isSuccess()) {
    /** @var \JPayApiLib\Models\PayTradeRefundResponse $result */
    $result = $apiResponse->getResult();
    var_dump($result);
}