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.
- 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
PaymentAdjustment
Overview
Represents refund on an Etsy Payments transaction. Please note all monetary amounts are in USD pennies unless otherwise specified.
Fields
Field | Visibility Level | Permission Scope | Type | Description |
---|---|---|---|---|
payment_adjustment_id |
private |
|
int |
The payment adjustment's numeric ID. |
payment_id |
private |
|
int |
The payment's numeric ID. |
status |
private |
|
string |
The status of the Payment Adjustment. Can be OPEN, REFUNDED, ERROR, or REFUND_FAILED. |
is_success |
private |
|
boolean |
Whether the Payment Adjustment was successful or will likely be completed successfully. |
user_id |
private |
|
int |
The seller's numeric ID. |
reason_code |
private |
|
string |
A human-readable string describing the need for the refund. |
total_adjustment_amount |
private |
|
int |
The total amount of the refund in the payment currency. |
shop_total_adjustment_amount |
private |
|
int |
The total amount of the refund in the shop currency. |
buyer_total_adjustment_amount |
private |
|
int |
The total amount of the refund in the buyer currency. |
total_fee_adjustment_amount |
private |
|
int |
The amount of card processing fees associated with this adjustment. |
create_date |
private |
|
int |
The date and time the payment adjustment was created in Epoch seconds. |
update_date |
private |
|
int |
The date and time the payment adjustment was last updated in Epoch seconds. |
Associations
This resource has no associations.
Methods
findPaymentAdjustments
Method Name | findPaymentAdjustments |
||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Synopsis | Get a Payment Adjustments from a Payment Id | ||||||||||||||||||||
HTTP Method | GET |
||||||||||||||||||||
URI | /payments/:payment_id/adjustments |
||||||||||||||||||||
Parameters |
|
||||||||||||||||||||
Requires OAuth | Y |
||||||||||||||||||||
Permission Scope |
|
findPaymentAdjustment
Method Name | findPaymentAdjustment |
||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Synopsis | Get an Etsy Payments Transaction Adjustment | ||||||||||||
HTTP Method | GET |
||||||||||||
URI | /payments/:payment_id/adjustments/:payment_adjustment_id |
||||||||||||
Parameters |
|
||||||||||||
Requires OAuth | Y |
||||||||||||
Permission Scope |
|
findPaymentAdjustmentForLedgerEntry
Method Name | findPaymentAdjustmentForLedgerEntry |
||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Synopsis | Get a Payment Adjustment from a Ledger Entry ID, if applicable | ||||||||||||
HTTP Method | GET |
||||||||||||
URI | /shops/:shop_id/ledger/entries/:ledger_entry_id/adjustment |
||||||||||||
Parameters |
|
||||||||||||
Requires OAuth | Y |
||||||||||||
Permission Scope |
|
findPaymentAdjustmentForPaymentAccountLedgerEntry
Method Name | findPaymentAdjustmentForPaymentAccountLedgerEntry |
||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Synopsis | Get a Payment Adjustment from a Payment Account Ledger Entry ID, if applicable | ||||||||||||
HTTP Method | GET |
||||||||||||
URI | /shops/:shop_id/payment_account/entries/:ledger_entry_id/adjustment |
||||||||||||
Parameters |
|
||||||||||||
Requires OAuth | Y |
||||||||||||
Permission Scope |
|