Etsy · JSON Structure

Open Api V3 Payment Adjustment Structure

Represents a refund, which applies to a prior Etsy payment. All monetary amounts are in USD pennies unless otherwise specified.

Type: object Properties: 15

MarketplaceEcommerceHandmadeListingsOrdersPaymentsReviewsShippingTaxonomyOAuth2

PaymentAdjustment is a JSON Structure definition published by Etsy, describing 15 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

payment_adjustment_id payment_id status is_success user_id reason_code total_adjustment_amount shop_total_adjustment_amount buyer_total_adjustment_amount total_fee_adjustment_amount create_timestamp created_timestamp update_timestamp updated_timestamp payment_adjustment_items

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/etsy/refs/heads/main/json-structure/open-api-v3-payment-adjustment-structure.json",
  "name": "PaymentAdjustment",
  "description": "Represents a refund, which applies to a prior Etsy payment. All monetary amounts are in USD pennies unless otherwise specified.",
  "type": "object",
  "properties": {
    "payment_adjustment_id": {
      "type": "int64",
      "description": "The numeric ID for a payment adjustment.",
      "minimum": 1,
      "example": 1
    },
    "payment_id": {
      "type": "int64",
      "description": "A unique numeric ID for a payment to a specific Etsy [shop](/documentation/reference#tag/Shop).",
      "minimum": 1,
      "example": 1
    },
    "status": {
      "type": "string",
      "description": "The status string of the payment adjustment.",
      "example": "example string"
    },
    "is_success": {
      "type": "boolean",
      "description": "When true, the payment adjustment was or is likely to complete successfully.",
      "example": true
    },
    "user_id": {
      "type": "int64",
      "description": "The numeric ID for the [user](/documentation/reference#tag/User) (seller) fulfilling the purchase.",
      "minimum": 1,
      "example": 456789
    },
    "reason_code": {
      "type": "string",
      "description": "A human-readable string describing the reason for the refund.",
      "example": "example string"
    },
    "total_adjustment_amount": {
      "type": "int32",
      "description": "The total numeric amount of the refund in the payment currency.",
      "nullable": true,
      "minimum": 0,
      "example": 2500
    },
    "shop_total_adjustment_amount": {
      "type": "int32",
      "description": "The numeric amount of the refund in the shop currency.",
      "nullable": true,
      "minimum": 0,
      "example": 2500
    },
    "buyer_total_adjustment_amount": {
      "type": "int32",
      "description": "The numeric amount of the refund in the buyer currency.",
      "nullable": true,
      "minimum": 0,
      "example": 2500
    },
    "total_fee_adjustment_amount": {
      "type": "int32",
      "description": "The numeric amount of card processing fees associated with a payment adjustment.",
      "nullable": true,
      "minimum": 0,
      "example": 2500
    },
    "create_timestamp": {
      "type": "int32",
      "description": "The transaction's creation date and time, in epoch seconds.",
      "minimum": 946684800,
      "example": 1758153645
    },
    "created_timestamp": {
      "type": "int32",
      "description": "The transaction's creation date and time, in epoch seconds.",
      "minimum": 946684800,
      "example": 1758153645
    },
    "update_timestamp": {
      "type": "int32",
      "description": "The date and time of the last change to the payment adjustment in epoch seconds.",
      "minimum": 946684800,
      "example": 1758153645
    },
    "updated_timestamp": {
      "type": "int32",
      "description": "The date and time of the last change to the payment adjustment in epoch seconds.",
      "minimum": 946684800,
      "example": 1758153645
    },
    "payment_adjustment_items": {
      "type": "array",
      "description": "List of payment adjustment line items.",
      "items": {
        "description": "List of payment adjustment line items.",
        "oneOf": [
          {
            "$ref": "#/components/schemas/PaymentAdjustmentItem"
          }
        ]
      }
    }
  }
}