Creates a refund proposal

Request

As a merchant you can only propose refunds; it is ultimately the buyer's decision to either accept or reject it (within a reasonable timeframe).

The following rules apply when proposing a refund:

Refunds must be enabled for your merchant account.
There can only be one active refund per payment. A new proposal is only allowed if the previous one was rejected.
The proposed amount must be at least 0.01 and cannot exceed the original payment total.
Refunds are not allowed for payments older than 3 months.
Offramp payments cannot be refunded.
A proposal that the buyer does not accept expires after 30 days, after which its status becomes expired.

Security

ApiKey

Path

payment_idstring, (UUID)required

The unique identifier (UUID) of the payment to refund.

Bodyapplication/vnd.api+json

Refund proposal to send to the buyer

dataobject

curl -i -X POST \
  'https://docs.xmoney.com/_mock/crypto_api/reference/stores/refund/{payment_id}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/vnd.api+json' \
  -d '{}'

Responses

Refund details