Xsolla-logo

Request partial refund

put/merchants/{merchant_id}/reports/transactions/{transaction_id}/partial_refund

Sends a partial refund request to return a part of a payment to a user. Please note that a partial refund is available only for credit card and PayPal payments. Read about the Refund feature to learn more about the process.

Note

You can call this API method in sandbox mode. To do this, pass the test payment data in the request. Refer to the instruction for more information about sandbox mode access and testing scenarios.

SecuritybasicAuth
Request
path Parameters
merchant_id
required
integer

Merchant ID.

transaction_id
required
integer

Transaction ID.

Request Body schema: application/json
description
required
string <= 4000 characters

Reason for a refund.

refund_amount
required
integer <float>

The refund amount in a purchase currency.

Responses
204

Refund request accepted

403

Do not have necessary permission

404

Transaction not found

422

Unprocessable entity

Request samples
application/json
{
  • "refund_amount": "1.50",
  • "description": "test refund request"
}
Response samples
application/json
{
  • "message": "Transaction with specified ID does not exist."
}