Skip to main content

SDK - Refund

Request parameters​

Parameter NameTypeRequired(Y or N)Sign(Y or N)Parameter Description
pay_memberidStringYYMerchant ID
transaction_idStringYYTransaction order number
pay_orderidStringYYMerchant order number
currencyStringYNOrder currency
pay_amountStringYNThe total amount of orders
refund_amountStringYNOrder refund amount(supports partial refund)
refund_reasonStringYNReason for order refund
pay_md5signStringYNPlease see MD5 signature field format

Refund return parameters​

Parameter NameTypeRequired(Y or N)Parameter Description
memberidStringYMerchant ID
transaction_idStringYTransaction order number
orderidStringYMerchant order number
currencyStringYOrder currency
amountStringYThe total amount of orders
refund_orderidStringNRefund Order ID (When the refund application is successful, a response will be returned.)
refund_amountStringYOrder refund amount (supports partial refund)
refund_reasonStringYReason for order refund
returncodeStringY"00": success
refund_messageStringY`V0000:OK
signStringYsign
require_once 'vendor/autoload.php';
use Jpay\PaymentSDK\JpayPaymentSDK;
$sdk = new JpayPaymentSDK(
'your_merchant_id',
'your_secret_key',
'virtual', // Write according to the payment method for which you want a refund. It doesn't matter if you make a mistake.
'true' // true or false, define true(dev environment)
);
//.The request parameters should be passed in according to the above requirements.
// There are mandatory and optional parameters to be passed in,
// depending on the document specifications.
$paymentData = [
'pay_orderid' => 'your pay orderid',
'transaction_id' => 'transaction id',
'pay_amount' => '100.00',
'currency' => 'USD',
'refund_amount' => '100.00',
'refund_reason' => 'refund',

];

$result = $sdk->refund($paymentData);