put

/merchants/{merchant_id}/reports/transactions/{transaction_id}/refund

Sends a refund request to return a payment to a user. Read about the Refund feature to learn more about the process.

Note

This API method can't be used under high load. When the number of requests is high, rate limits may apply. Contact your Account Manager to find out the rate limits for this API method.

Authorization

basic

Request Parameters

2 Path Parameters

Request Body

1 Example
Schema
object
$schema: http://json-schema.org/draft-04/schema#
description
string

Reason for a refund.

required
email
string

User email.

Responses

OK (No error).

1 Example
Schema
object
$schema: http://json-schema.org/draft-04/schema#
message
string

Can return one of two messages:

  • The request for a refund has been accepted. Xsolla CS will manually complete the refund. It may take up to two business days.
  • The request for a refund has been accepted. Xsolla CS will automatically send the customer an email with alternative refund options as the user’s method does not support direct refunds.

Send a Test Request

Send requests directly from the browser (CORS must be enabled)
Path Params
2 path params not set
merchant_id
transaction_id
$$.env
username
password