# Get a refund by ID

Retrieves a single refund by its unique identifier.

Endpoint: GET /v1/api/refunds/{id}
Version: 1.2.4
Security: X-Api-Key

## Path parameters:

  - `id` (string, required)
    Refunds ID

## Response 200 fields (application/json):

  - `id` (string)
    Unique identifier for the Refunds.
    Example: "o1p2q3r4s5t6u7v8w9x0y1z2"

  - `createdAt` (string)
    Timestamp when the Refunds was created.
    Example: "2025-12-07T19:31:48.436+00:00"

  - `updatedAt` (string)
    Timestamp when the Refunds was last updated.
    Example: "2025-12-07T19:35:48.436+00:00"

  - `companyId` (string)
    Company ID associated with the Refunds.
    Example: "o1p2q3r4s5t6u7v8w9x0y1z2"

  - `orderId` (string)
    Order ID associated with the refund.
    Example: "507f1f77bcf86cd799439011"

  - `sessionId` (string)
    Session ID associated with the refund.
    Example: "507f1f77bcf86cd799439012"

  - `externalId` (string)
    External ID of the refund.
    Example: "ext_refund_123"

  - `currency` (string)
    Currency of the refund.
    Example: "USD"

  - `fromFinal` (boolean)
    Flag to indicate if the Refund is created from Final.

  - `lineItems` (array)
    Line items included in the refund.
    Example: [{"name":"Sweet Tea","quantity":1,"price":"5.00","total":"5.00","productId":"507f1f77bcf86cd799439011","variantId":"507f1f77bcf86cd799439012"}]

  - `lineItems.taxes` (array)
    Taxes applied to the line item.
    Example: [{"name":"Sales Tax","amount":"10.00","percentage":10}]

  - `lineItems.taxes.name` (string, required)
    Name of the tax.
    Example: "Sales Tax"

  - `lineItems.taxes.amount` (string, required)
    Amount of the tax.
    Example: "10.00"

  - `lineItems.taxes.percentage` (number, required)
    Percentage of the tax.
    Example: 10

  - `lineItems.discount` (object)
    Discount applied to the line item.
    Example: {"cartDiscount":{"amount":"5.00","percentage":5}}

  - `lineItems.discount.cartDiscount` (object)
    Cart discount applied to the refund.
    Example: {"amount":"5.00","percentage":5}

  - `lineItems.discount.cartDiscount.amount` (string)
    Amount of the cart discount.
    Example: "5.00"

  - `lineItems.discount.cartDiscount.percentage` (number)
    Percentage of the cart discount.
    Example: 5

  - `lineItems.discount.itemDiscount` (object)
    Item discount applied to the refund.
    Example: {"amount":"2.50","percentage":2.5}

  - `lineItems.discount.itemDiscount.amount` (string)
    Amount of the item discount.
    Example: "2.50"

  - `lineItems.discount.itemDiscount.percentage` (number)
    Percentage of the item discount.
    Example: 2.5

  - `lineItems.quantity` (number)
    Quantity of the line item.
    Example: 2

  - `lineItems.total` (string)
    Total amount of the line item.
    Example: "50.00"

  - `lineItems.price` (string)
    Price per unit of the line item.
    Example: "25.00"

  - `lineItems.name` (string)
    Name of the line item.
    Example: "Sweet Tea"

  - `lineItems.subTotal` (string)
    Subtotal of the line item before taxes.
    Example: "45.00"

  - `lineItems.sku` (string)
    SKU of the line item.
    Example: "SKU-001"

  - `lineItems.image` (string)
    Image URL of the line item.
    Example: "https://example.com/image.jpg"

  - `lineItems.productId` (string, required)
    Product ID of the line item.
    Example: "507f1f77bcf86cd799439011"

  - `lineItems.productExternalId` (string)
    External product ID.
    Example: "ext_prod_123"

  - `lineItems.variantExternalId` (string)
    External variant ID.
    Example: "ext_var_123"

  - `lineItems.lineItemExternalId` (string)
    External line item ID.
    Example: "ext_line_123"

  - `lineItems.internalId` (string)
    Internal ID of the line item.
    Example: "int_line_123"

  - `lineItems.action` (string)
    Inventory action type for the line item.
    Example: "restock"

  - `lineItems.variantId` (string, required)
    Variant ID of the line item.
    Example: "507f1f77bcf86cd799439012"

  - `lineItems.totalTax` (string)
    Total tax amount for the line item.
    Example: "5.00"

  - `lineItems.note` (string)
    Note for the line item.
    Example: "No ice please"

  - `lineItems.description` (string)
    Description of the line item.
    Example: "Refreshing sweet tea beverage"

  - `reason` (string)
    Reason for the refund.
    Example: "Customer requested refund"

  - `refundedBy` (string)
    User ID of who processed the refund.
    Example: "507f1f77bcf86cd799439013"

  - `refundedByExternalId` (string)
    External ID of the user who processed the refund.
    Example: "ext_user_123"

  - `summary` (object)
    Summary of the refund amounts.
    Example: {"total":"100.00","subTotal":"90.00","totalTaxes":"10.00"}

  - `summary.discountTotal` (string)
    Total discount amount.
    Example: "10.00"

  - `summary.shippingTotal` (string)
    Total shipping amount.
    Example: "5.00"

  - `summary.total` (string)
    Total amount of the refund.
    Example: "100.00"

  - `summary.totalTaxes` (string)
    Total taxes amount.
    Example: "10.00"

  - `summary.subTotal` (string)
    Subtotal before taxes and discounts.
    Example: "90.00"

  - `summary.taxes` (array)
    List of taxes applied to the refund.
    Example: [{"name":"Sales Tax","percentage":10,"amount":"10.00"}]

  - `summary.tip` (object)
    Tip included in the refund.
    Example: {"amount":"5.00","percentage":15}

  - `summary.tip.amount` (string)
    Amount of the tip.
    Example: "5.00"

  - `summary.tip.percentage` (number)
    Percentage of the tip.
    Example: 15

  - `payment` (array)
    Payment details for the refund.
    Example: [{"paymentType":"credit_card","amount":"100.00","transactionId":"txn_123"}]

  - `payment.transactionId` (string)
    Transaction ID of the payment.
    Example: "txn_123456789"

  - `payment.paymentType` (string)
    Type of payment method.
    Example: "credit_card"

  - `payment.amount` (string)
    Amount of the payment.
    Example: "100.00"

  - `payment.timestamp` (string)
    Timestamp of the payment.
    Example: "2025-01-29T12:00:00.000Z"

  - `payment.processor` (string)
    Payment processor used.
    Example: "stripe"

  - `payment.saleId` (string)
    Sale ID associated with the payment.
    Example: "sale_123456789"

  - `balance` (string)
    Balance remaining after the refund.
    Example: "0.00"

## Response 400 fields (application/json):

  - `statusCode` (number, required)
    HTTP status code
    Example: 400

  - `message` (string, required)
    Error message describing what went wrong
    Example: "Validation failed: Field `schemaField` is required."

  - `error` (string, required)
    Error type/name
    Enum: "Bad Request", "Unauthorized", "Forbidden", "Not Found", "Conflict", "Unprocessable Entity", "Internal Server Error"

## Response 404 fields (application/json):

  - `statusCode` (number, required)
    HTTP status code
    Example: 404

  - `message` (string, required)
    Error message describing what went wrong
    Example: "The resource was not found."

  - `error` (string, required)
    Error type/name
    Enum: "Bad Request", "Unauthorized", "Forbidden", "Not Found", "Conflict", "Unprocessable Entity", "Internal Server Error"