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

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 transactions_r int The payment adjustment's numeric ID.
payment_id private transactions_r int The payment's numeric ID.
status private transactions_r string The status of the Payment Adjustment. Can be OPEN, REFUNDED, ERROR, or REFUND_FAILED.
is_success private transactions_r boolean Whether the Payment Adjustment was successful or will likely be completed successfully.
user_id private transactions_r int The seller's numeric ID.
reason_code private transactions_r string A human-readable string describing the need for the refund.
total_adjustment_amount private transactions_r int The total amount of the refund in the payment currency.
shop_total_adjustment_amount private transactions_r int The total amount of the refund in the shop currency.
buyer_total_adjustment_amount private transactions_r int The total amount of the refund in the buyer currency.
total_fee_adjustment_amount private transactions_r int The amount of card processing fees associated with this adjustment.
create_date private transactions_r int The date and time the payment adjustment was created in Epoch seconds.
update_date private transactions_r 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
Name Required Default Type
payment_id Y   int
limit N 25 int
offset N 0 int
page N   int
Requires OAuth Y
Permission Scope transactions_r

findPaymentAdjustment

Method Name findPaymentAdjustment
Synopsis Get an Etsy Payments Transaction Adjustment
HTTP Method GET
URI /payments/:payment_id/adjustments/:payment_adjustment_id
Parameters
Name Required Default Type
payment_id Y   int
payment_adjustment_id Y   int
Requires OAuth Y
Permission Scope transactions_r

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
Name Required Default Type
shop_id Y   shop_id_or_name
ledger_entry_id Y   array(int)
Requires OAuth Y
Permission Scope transactions_r

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
Name Required Default Type
shop_id Y   shop_id_or_name
ledger_entry_id Y   array(int)
Requires OAuth Y
Permission Scope transactions_r

Open API v3New

Your developer account