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

Payment

Overview

Represents a Payment made with Etsy Payments. Please note all monetary amounts are in USD pennies unless otherwise specified.

Fields

Field Visibility Level Permission Scope Type Description
payment_id private transactions_r int The payment's numeric ID.
buyer_user_id private transactions_r int The buyer's numeric ID.
shop_id private transactions_r int The shop's numeric ID.
receipt_id private transactions_r int The receipt's numeric ID.
amount_gross private transactions_r int The original gross amount of the order, in pennies - this is grand total, including shipping and taxes.
amount_fees private transactions_r int The original card processing fee of the order in pennies.
amount_net private transactions_r int The total value of the payment less fees (amount_gross - amount_fees).
posted_gross private transactions_r int The gross amount which posted to the ledger once shipped. This is equal to the amount_gross UNLESS the seller issues a refund prior to shipping. We consider "shipping" to the event which "posts" to the ledger. Therefore, if the seller refunds first, we simply reduce the amount_gross and post that amount. The seller never sees the refunded amount in their ledger. This is equal to the "Credit" amount in the ledger entry.
posted_fees private transactions_r int Amount of the fees that posted when shipped. We refund a proportional amount of the fees when a seller refunds a buyer. If they refund prior to shipping, the posted amount will be less then the original.
posted_net private transactions_r int The total value of the payment at the time of posting it to the ledger less fees (posted_gross - posted_fees)
adjusted_gross private transactions_r int If the payment is refunded, partially or fully, this is the new gross amount after the refund.
adjusted_fees private transactions_r int If the payment is refunded, partially or fully, this is the new fee amount after the refund.
adjusted_net private transactions_r int The total value of the payment after refunds less fees (adjusted_gross - adjusted_fees).
currency private transactions_r string What currency the payment was made in.
shop_currency private transactions_r string The currency of the shop.
buyer_currency private transactions_r string The currency of the buyer.
shipping_user_id private transactions_r int The numeric id of the user to which the order is being shipped.
shipping_address_id private transactions_r int The numeric id identifying the shipping address.
billing_address_id private transactions_r int The numeric id identifying the billing address of the buyer.
status private transactions_r string Most commonly "settled" or "authed". Marks the current status of the payment.
shipped_date private transactions_r int The date and time the payment was shipped in Epoch seconds.
create_date private transactions_r int The date and time the payment was created in Epoch seconds.
update_date private transactions_r int The date and time the payment was last updated in Epoch seconds.

Associations

This resource has no associations.

Methods

findPayment

Method Name findPayment
Synopsis Get an Etsy Payments Transaction
HTTP Method GET
URI /payments/:payment_id
Parameters
Name Required Default Type
payment_id Y   array(int)
Requires OAuth Y
Permission Scope transactions_r

findPaymentForLedgerEntry

Method Name findPaymentForLedgerEntry
Synopsis Get a Payment from a Ledger Entry ID, if applicable
HTTP Method GET
URI /shops/:shop_id/ledger/entries/:ledger_entry_id/payment
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

findPaymentForPaymentAccountLedgerEntry

Method Name findPaymentForPaymentAccountLedgerEntry
Synopsis Get a Payment from a PaymentAccount Ledger Entry ID, if applicable
HTTP Method GET
URI /shops/:shop_id/payment_account/entries/:ledger_entry_id/payment
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

findShopPaymentByReceipt

Method Name findShopPaymentByReceipt
Synopsis Get a Payment by Shop Receipt ID
HTTP Method GET
URI /shops/:shop_id/receipts/:receipt_id/payments
Parameters
Name Required Default Type
receipt_id Y   int
shop_id Y   shop_id_or_name
Requires OAuth Y
Permission Scope transactions_r

Open API v3New

Your developer account