Skip to main content

Do Refund

Refund the order(s).

Post
https://store.payproglobal.com/api/Orders/DoRefund
Request Parametersapplication/json
DoChargeRequestModel
object
orderIds
array[integer]
conditional
The order ID(s) for which you want to initiate the refund.
If the order is linked to a subscription, processing a refund will terminate it.
emailAddresses
array[string]
conditional
The customer's email address(es) for which you want to initiate the refund.
All orders associated with the provided email address(es) will be refunded,
regardless of any values entered under orderIds. Omit it, if you want to refund
only specific orders listed in orderIds.
refundReason
string
required
The reason of the refund request.
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
orderId
integer
The order ID that needs to be refunded.
customerEmail
string
The customer's email whose order(s) should be refunded.
isRefundSuccessful
boolean
Possible values are true or false.
If true, the refund request is successful.
If false, the refund request failed.
refundNotice
string
The note if the refund request failed.
request
object
orderIds
array[integer]
The order ID(s) for which you want to initiate the refund.
If the order is linked to a subscription, processing a refund will terminate it.
emailAddresses
array[string]
The customer's email address(es) for which you want to initiate the refund.
If no OrderIds is provided, the refund will be initiated for all customer's
order IDs with the specified email address.
refundReason
string
The reason of the refund request.
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
{
  "orderIds": [
    12345678,
    12345678
  ],
  "emailAddresses": [
    "[email protected]",
    "[email protected]"
  ],
  "refundReason": "your_refund_reason.",
  "vendorAccountId": 123456,
  "apiSecretKey": "your_api_secret_key"
}
Response Sample
{
  "response": [{
    "orderId": 12345678,
    "customerEmail": "[email protected]",
    "isRefundSuccessful": true,
    "refundNotice": null
  },
  {
    "orderId": 12345678,
    "customerEmail": "[email protected]",
    "isRefundSuccessful": true,
    "refundNotice": null
  }],
  "request": {
    "orderIds": [
      12345678,
      12345678
    ],
    "emailAddresses": [
      "[email protected]",
      "[email protected]"
    ],
    "refundReason": "your_refund_reason.",
    "vendorAccountId": 123456,
    "apiSecretKey": "your_api_secret_key"
  },
  "errors": [],
  "isSuccess": true
}