Balance

Refund balance.

post/admin/balance/refund.json

Request

Base URL
https://shop-name.onshopbase.com
Auth
API key in header USER_ACCESS_TOKEN
TypeScript
https://skmtc.dev/shopbase/apis/shopbase-internal-api/docs/admin/balance/refund.json/post.ts
A function with typed inputs. Its response is checked against the schema.

amountnumber

Refund amount.

order_idinteger

OrderId to refund ( optional )

reason_titlestring

Refund reason.

transaction_typestring

Transaction type.

{
  "amount": 10,
  "order_id": 123456,
  "reason_title": "Refunded for the order #1234567",
  "transaction_type": "order_refund"
}

successboolean

Is Refund successfully.

{
  "success": true
}

No recorded changes to this operation across all 1 revision of this API.