Xsolla-logo

Request partial refundServer-side

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

Sends a request for a partial refund to a user. Refer to our documentation for detailed information about the refund process and payment methods that support partial refunds.

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.

Notice

This API call does not contain the project_id path parameter, so you need to use the API key that is valid in all the company’s projects to set up authorization.

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
number <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.5,
  • "description": "test refund request"
}
Response samples
application/json
{
  • "message": "Transaction with specified ID does not exist."
}