Skip to main content

Do Partial Refund

Do the partial refund of the order item.

Request Parametersapplication/json
DoPartialRefundRequestModel
object
orderItemId
integer
required
The order item ID you want to partially refund. Its value is passed
via the parameter ORDER_ITEM_ID in IPN/webhook or PayPro Order Notification email.
refundAmount
number
required
The amount you want to reimburse to the customer.
changeSubscriptionPrice
boolean
Possible values are true or false. If true,
the recurring subscription price will be updated according to the remaining amount
after the refund. If false, the recurring subscription price won't be changed. False by default.
refundReason
string
required
The reason for the partial refund.
cancelSubscription
boolean
Possible values are true or false. If true, the subscription
will get Suspended status. If false, it remains active. False by default.
subscriptionCancellationReasonText
string
The reason for subscription cancelation.
vendorAccountId
integer
required
The vendor account ID identifies your PayPro Global account.
It can be found in Account settings > Business info.
apiSecretKey
string
required
The vendor account API secret key is a unique key
that was generated specifically for authenticating API requests.
It can be found in Store settings > General settings > Integration tab.
Response Parametersapplication/json
DoChargeResponseModel
object
response
object
orderItemId
integer
The order item ID you want to partially refund.
isRefundSuccessful
boolean
Possible values are true or false. If true, the partial refund request
is successful. If false, the partial refund request failed.
refundNotice
string
The note if the refund request failed.
request
object
orderItemId
integer
The order item ID you want to partially refund. Its value is passed
via the parameter ORDER_ITEM_ID in IPN/webhook or PayPro Order Notification email.
refundAmount
number
The amount you want to reimburse to the customer.
changeSubscriptionPrice
boolean
Possible values are true or false. If true,
the recurring subscription price will be updated according to the remaining amount
after the refund. If false, the recurring subscription price won't be changed. False by default.
refundReason
string
The reason for the partial refund.
cancelSubscription
boolean
Possible values are true or false. If true, the subscription
will get Suspended status. If false, it remains active. False by default.
subscriptionCancellationReasonText
string
The reason for subscription cancelation.
vendorAccountId
integer
The vendor account ID identifies your PayPro Global account.
It can be found in Account settings > Business info.
apiSecretKey
string
The vendor account API secret key is a unique key
that was generated specifically for authenticating API requests.
It can be found in Store settings > General settings > Integration tab.
errors
array[object]
propertyWithError
string
propertyErrorMessages
array[string]
isSuccess
boolean
Request Sample
{
"orderItemId": 1,
"refundAmount": 2.0,
"changeSubscriptionPrice": true,
"refundReason": "Product doesn't correspond to customer's expectation.",
"cancelSubscription": true,
"subscriptionCancellationReasonText": "sample string 6",
"vendorAccountId": 123456,
"apiSecretKey": "your_api_secret_key"
}
Response Sample
{
"response": {
"orderItemId": 1,
"isRefundSuccessful": false,
"refundNotice": "Order #5458995 is not in refundable state"
},
"request": {
"orderItemId": 1,
"refundAmount": 2.0,
"changeSubscriptionPrice": true,
"refundReason": "Product doesn't correspond to customer's expectation.",
"cancelSubscription": true,
"subscriptionCancellationReasonText": "sample string 6",
"vendorAccountId": 123456,
"apiSecretKey": "your_api_secret_key"
},
"errors": [
{
"propertyWithError": "orderId",
"propertyErrorMessages": [
"Error message 1",
"Error message 2"
]
},
{
"propertyWithError": "orderId",
"propertyErrorMessages": [
"Error message 1",
"Error message 2"
]
}
],
"isSuccess": false
}