Open API v2 will be deprecated on April 3, 2023. Please begin transitioning to Open API v3 as soon as possible. As of September 29, 2022 all new apps will only be permitted to use Open API v3.
API Documentation
- ApiMethod
- BillCharge
- BillingOverview
- BillPayment
- Cart
- CartListing
- Country
- Coupon
- DataType
- FavoriteListing
- FavoriteUser
- Feedback
- FeedbackInfo
- ForumPost
- Guest
- GuestCart
- ImageType
- Ledger
- LedgerEntry
- Listing
- ListingFile
- ListingImage
- ListingInventory
- ListingOffering
- ListingProduct
- ListingTranslation
- ListingVariationImage
- Money
- ParamList
- Payment
- PaymentAccountLedgerEntry
- PaymentAdjustment
- PaymentAdjustmentItem
- PaymentTemplate
PaymentAdjustmentItem
Overview 
An Etsy Payments transaction may have adjustments, or refunds. These adjustments can have different items, associated with the area being refunded, like shipping, sales tax, or the item itself. Please note all monetary amounts are in USD pennies unless otherwise specified.
Fields
| Field | Visibility Level | Permission Scope | Type | Description |
|---|---|---|---|---|
payment_adjustment_item_id |
private |
|
int |
The payment adjustment item's numeric ID. |
payment_adjustment_id |
private |
|
int |
The payment adjustment's numeric ID. |
adjustment_type |
private |
|
string |
A human readable string describing the area being refundedOne of: TRANS, TAX, or SHIP |
amount |
private |
|
int |
The total amount of the payment adjustment item. |
transaction_id |
private |
|
int |
The numerice ID of the Credit Card Transaction |
create_date |
private |
|
int |
The date and time the payment adjustment item was created in Epoch seconds. |
Associations
This resource has no associations.
Methods
findPaymentAdjustmentItems
| Method Name | findPaymentAdjustmentItems |
||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Synopsis | Get Etsy Payments Transaction Adjustment Items | ||||||||||||||||||||||||
| HTTP Method | GET |
||||||||||||||||||||||||
| URI | /payments/:payment_id/adjustments/:payment_adjustment_id/items |
||||||||||||||||||||||||
| Parameters |
|
||||||||||||||||||||||||
| Requires OAuth | Y |
||||||||||||||||||||||||
| Permission Scope | |
findPaymentAdjustmentItem
| Method Name | findPaymentAdjustmentItem |
||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Synopsis | Get an Etsy Payments Transaction Adjustment Item | ||||||||||||||||
| HTTP Method | GET |
||||||||||||||||
| URI | /payments/:payment_id/adjustments/:payment_adjustment_id/items/:payment_adjustment_item_id |
||||||||||||||||
| Parameters |
|
||||||||||||||||
| Requires OAuth | Y |
||||||||||||||||
| Permission Scope | |