Refunds

Upsert Refund

put/v1/transactions/refunds/{transaction_id}

Request

  • Base URL: https://api.blueonion.ai (the document declares no server; this is the origin it was published from)
  • URL: https://api.blueonion.ai/v1/transactions/refunds/{transaction_id}
  • Auth: HTTP bearer

Path parameters

transaction_idstring required

Request body

transaction_idstring required
transaction_datestring date-time required
currencystring required
gross_pricenumber required
discountsnumber required
shippingnumber required
taxnumber required
total_pricenumber required
cancelled_atstring date-time nullable
additional_feesnumber nullable
dutiesnumber nullable
tipnumber nullable
gift_card_gross_salesnumber nullable
gift_card_net_salesnumber nullable
payment_gatewaystring nullable
payment_processor_feesnumber nullable
net_settlementnumber nullable
settlement_datestring date-time nullable
payout_idstring nullable
payment_methodstring nullable
financial_statusstring nullable
fulfillment_statusstring nullable
fulfilled_atstring date-time nullable
channelstring nullable
locationstring nullable
country_codestring nullable
statestring nullable
postal_codestring nullable
customer_idstring nullable
discount_codestring nullable
edit_versioninteger nullable
external_checkout_idstring nullable
namestring nullable
taxes_includedboolean nullable
transaction_reference_idstring required
refund_reasonstring nullable
is_exchangeboolean nullable

Response

Successful Response

transaction_idstring required
actionstring required
messagestring required

Changes

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