Skip to main content

refund

POST 

/refund

The merchant sends a request to this endpoint to refund an order partially or in full. This can only be done when the order has been confirmed ('order_confirmed').

Locking: Each refund request is assigned a locked_at deadline based on the time it was submitted (in CST / America/Chicago):

  • Submitted before 5:00 PM CST on a weekday → locks at 5:00 PM CST that same day.
  • Submitted at or after 5:00 PM CST Mon–Thu → locks at 5:00 PM CST the next weekday.
  • Submitted at or after 5:00 PM CST on Friday, or submitted on Saturday or Sunday → locks at 5:00 PM CST the following Monday.

Once locked, the refund request can no longer be replaced or deleted by the merchant.

Updating the refund amount: Only one active refund request (in draft or approved state) can exist per order at a time. To change the refund amount, submit a new POST request with the updated refund_amount. If an existing active, non-locked refund request is found it will automatically be declined and replaced by the new one. Locked refund requests cannot be replaced.

Request

Body

required
    backd_order_id stringrequired
    merchant_order_id stringrequired
    refund_amount numberrequired

Responses

Refund details.

Schema
    data object

    Order data returned by post-order management endpoints.

    backd_order_id string
    create_date string
    order_total number
    cart_amount number
    tax_amount number
    shipping_amount number
    discount_amount number
    status string
    merchant_order_id string
    merchant_order_status string

    Not returned by cancel_order.

    shipping object

    Name, address, phone, and email for a shipping or billing contact.

    name objectrequired

    First and last name of a person.

    first stringrequired
    last stringrequired
    company_name stringrequired
    address objectrequired

    Postal address.

    line1 stringrequired
    line2 string

    Second address line (optional).

    city stringrequired
    state stringrequired
    zipcode stringrequired
    country stringrequired
    phone_number stringrequired
    email stringrequired
    billing object

    Name, address, phone, and email for a shipping or billing contact.

    name objectrequired

    First and last name of a person.

    first stringrequired
    last stringrequired
    company_name stringrequired
    address objectrequired

    Postal address.

    line1 stringrequired
    line2 string

    Second address line (optional).

    city stringrequired
    state stringrequired
    zipcode stringrequired
    country stringrequired
    phone_number stringrequired
    email stringrequired
    items object[]
  • Array [
  • display_name stringrequired
    sku stringrequired
    unit_price numberrequired
    qty numberrequired
    item_image_url string

    URL of the item's image (optional).

    item_url string

    URL of the item's page (optional).

  • ]
  • refunds object[]

    Present on find_order, refund POST, and refund DELETE responses.

  • Array [
  • amount number
    create_date string
    status string
    locked_at string
  • ]
  • message string
    status object
    type string
    code integer
    error boolean
Loading...