Etsy · JSON Structure
Open Api V3 Payment Structure
Represents a payment made with Etsy Payments. All monetary amounts are in USD pennies unless otherwise specified.
Type: object
Properties: 26
MarketplaceEcommerceHandmadeListingsOrdersPaymentsReviewsShippingTaxonomyOAuth2
Payment is a JSON Structure definition published by Etsy, describing 26 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.
Properties
payment_id
buyer_user_id
shop_id
receipt_id
amount_gross
amount_fees
amount_net
posted_gross
posted_fees
posted_net
adjusted_gross
adjusted_fees
adjusted_net
currency
shop_currency
buyer_currency
shipping_user_id
shipping_address_id
billing_address_id
status
shipped_timestamp
create_timestamp
created_timestamp
update_timestamp
updated_timestamp
payment_adjustments
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-structure.json",
"name": "Payment",
"description": "Represents a payment made with Etsy Payments. All monetary amounts are in USD pennies unless otherwise specified.",
"type": "object",
"properties": {
"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
},
"buyer_user_id": {
"type": "int64",
"description": "The numeric ID for the [user](/documentation/reference#tag/User) who paid the purchase.",
"minimum": 1,
"example": 456789
},
"shop_id": {
"type": "int64",
"description": "The unique positive non-zero numeric ID for an Etsy Shop.",
"minimum": 1,
"example": 123456
},
"receipt_id": {
"type": "int64",
"description": "The numeric ID for the [receipt](/documentation/reference#tag/Shop-Receipt) associated to this transaction.",
"minimum": 1,
"example": 234567890
},
"amount_gross": {
"description": "An integer equal to gross amount of the order, in pennies, including shipping and taxes.",
"oneOf": [
{
"$ref": "#/components/schemas/Money"
}
],
"example": "example"
},
"amount_fees": {
"description": "An integer equal to the original card processing fee of the order in pennies.",
"oneOf": [
{
"$ref": "#/components/schemas/Money"
}
],
"example": "example"
},
"amount_net": {
"description": "An integer equal to the payment value, in pennies, less fees (`amount_gross` - `amount_fees`).",
"oneOf": [
{
"$ref": "#/components/schemas/Money"
}
],
"example": "example"
},
"posted_gross": {
"description": "The total gross value of the payment posted once the purchase ships. This is equal to the `amount_gross` UNLESS the seller issues a refund prior to shipping. We consider \"shipping\" to be the event which \"posts\" to the ledger. Therefore, if the seller refunds first, we reduce the `amount_gross` first and post then that amount. The seller never sees the refunded amount in their ledger. This is equal to the \"Credit\" amount in the ledger entry.",
"oneOf": [
{
"$ref": "#/components/schemas/Money"
}
],
"nullable": true,
"example": "example"
},
"posted_fees": {
"description": "The total value of the fees posted once the purchase ships. Etsy refunds a proportional amount of the fees when a seller refunds a buyer. When the seller issues a refund prior to shipping, the posted amount is less than the original.",
"oneOf": [
{
"$ref": "#/components/schemas/Money"
}
],
"nullable": true,
"example": "example"
},
"posted_net": {
"description": "The total value of the payment at the time of posting, less fees. (`posted_gross` - `posted_fees`)",
"oneOf": [
{
"$ref": "#/components/schemas/Money"
}
],
"nullable": true,
"example": "example"
},
"adjusted_gross": {
"description": "The gross payment amount after the seller refunds a payment, partially or fully.",
"oneOf": [
{
"$ref": "#/components/schemas/Money"
}
],
"nullable": true,
"example": "example"
},
"adjusted_fees": {
"description": "The new fee amount after a seller refunds a payment, partially or fully.",
"oneOf": [
{
"$ref": "#/components/schemas/Money"
}
],
"nullable": true,
"example": "example"
},
"adjusted_net": {
"description": "The total value of the payment after refunds, less fees (`adjusted_gross` - `adjusted_fees`).",
"oneOf": [
{
"$ref": "#/components/schemas/Money"
}
],
"nullable": true,
"example": "example"
},
"currency": {
"type": "string",
"description": "The ISO (alphabetic) code string for the payment's currency.",
"example": "example string"
},
"shop_currency": {
"type": "string",
"description": "The ISO (alphabetic) code for the shop's currency. The shop displays all prices in this currency by default.",
"nullable": true,
"example": "example string"
},
"buyer_currency": {
"type": "string",
"description": "The currency string of the buyer.",
"nullable": true,
"example": "example string"
},
"shipping_user_id": {
"type": "int64",
"description": "The numeric ID of the user to which the seller ships the order.",
"nullable": true,
"minimum": 1,
"example": 456789
},
"shipping_address_id": {
"type": "int64",
"description": "The numeric id identifying the shipping address.",
"minimum": 1,
"example": 1
},
"billing_address_id": {
"type": "int32",
"description": "The numeric ID identifying the billing address of the buyer.",
"minimum": 0,
"maximum": 9223372036854775807,
"example": 1
},
"status": {
"type": "string",
"description": "A string indicating the current status of the payment, most commonly \"settled\" or \"authed\".",
"example": "example string"
},
"shipped_timestamp": {
"type": "int32",
"description": "The transaction's shipping date and time, in epoch seconds.",
"nullable": true,
"minimum": 946684800,
"example": 1758153645
},
"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_adjustments": {
"type": "array",
"description": "List of refund objects on an Etsy Payments transaction. All monetary amounts are in USD pennies unless otherwise specified.",
"items": {
"description": "List of refund objects on an Etsy Payments transaction. All monetary amounts are in USD pennies unless otherwise specified.",
"oneOf": [
{
"$ref": "#/components/schemas/PaymentAdjustment"
}
]
}
}
}
}