API reference Orders Refund an order

Refund an order

POST methodhttps://api.anyshop.io/v1/orders/{id}/refund

Through the payment rail that took it. Crypto payments are refunded from the seller's wallet instead. Send an Idempotency-Key.

Scope orders:write
Idempotent with Idempotency-Key
Works while the store is suspended

Path parameters

idstring required

Body

application/json0 required, 2 optional

amountinteger How much, in minor units; the rest of the order when left outAt least 1
revoke_deliveredboolean Take back keys, licenses and downloads (default false)

Headers

Idempotency-Keystring Up to 255 characters. A retry with the same key and request gets the first answer, without running twice (24 hours).

Example

as_live_ or as_test_

curl -X POST \
  https://api.anyshop.io/v1/orders/ord_01m3rt5x2c7q9f0a4d6k8h1n3p/refund \
  -H "Authorization: Bearer $ANYSHOP_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
    "amount": 1999
  }'

{
  "object": "order",
  "id": "ord_01m3rt5x2c7q9f0a4d6k8h1n3p",
  "number": 1001,
  "livemode": false,
  "status": "delivered",
  "currency": "USD",
  "subtotal": 1999,
  "discount": 0,
  "total": 1999,
  "refunded": 0,
  "coupon": null,
  "buyer": {
    "email": "buyer@example.com"
  },
  "paid_with": "simulated",
  "created_at": "2026-10-02T14:21:07.000Z",
  "paid_at": "2026-10-02T14:21:07.000Z",
  "delivered_at": "2026-10-02T14:21:07.000Z",
  "items": [
    {
      "id": "oi_01m3rt5x4e9s1h2c6d8f0g2j4k",
      "product": {
        "id": "prod_01m3rr5kmbeb2s18x1kpntjxqb",
        "name": "Lumen Studio Pro",
        "type": "serial"
      },
      "variant": {
        "id": "var_01m3rr5kmd6h0q2t8w4y9zb7ce",
        "name": "Standard"
      },
      "quantity": 1,
      "unit_amount": 1999,
      "total_amount": 1999,
      "delivery_state": "pending"
    }
  ]
}

The IDs and keys in these examples are made up. Every schema is in the OpenAPI document, served at https://api.anyshop.io/v1/openapi.json.

Returns

The order object.

Errors

Status and error.type

400invalid_requestThe request is not valid; error.param names the field
401authenticationNo API key, or it is not valid
403permissionThe key does not have the scope this needs, it is a test key where only a live key may act (the catalog), or the store is suspended (store_suspended)
404not_foundNot found in the key's store and mode
409conflictConflicts with the object's state (type conflict), or an Idempotency-Key reused for another request (type idempotency, code idempotency_key_reused)
429rate_limitedToo many requests; see Retry-After