Skip to content

Latest commit

 

History

History
34 lines (31 loc) · 4.59 KB

Payment.md

File metadata and controls

34 lines (31 loc) · 4.59 KB

Payment

Properties

Name Type Description Notes
payment_id int A unique numeric ID for a payment to a specific Etsy shop. [optional]
buyer_user_id int The numeric ID for the user who paid the purchase. [optional]
shop_id int The unique positive non-zero numeric ID for an Etsy Shop. [optional]
receipt_id int The numeric ID for the receipt associated to this transaction. [optional]
amount_gross AllOfPaymentAmountGross An integer equal to gross amount of the order, in pennies, including shipping and taxes. [optional]
amount_fees AllOfPaymentAmountFees An integer equal to the original card processing fee of the order in pennies. [optional]
amount_net AllOfPaymentAmountNet An integer equal to the payment value, in pennies, less fees (`amount_gross` - `amount_fees`). [optional]
posted_gross AllOfPaymentPostedGross 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. [optional]
posted_fees AllOfPaymentPostedFees 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 then the original. [optional]
posted_net AllOfPaymentPostedNet The total value of the payment at the time of posting, less fees. (`posted_gross` - `posted_fees`) [optional]
adjusted_gross AllOfPaymentAdjustedGross The gross payment amount after the seller refunds a payment, partially or fully. [optional]
adjusted_fees AllOfPaymentAdjustedFees The new fee amount after a seller refunds a payment, partially or fully. [optional]
adjusted_net AllOfPaymentAdjustedNet The total value of the payment after refunds, less fees (`adjusted_gross` - `adjusted_fees`). [optional]
currency string The ISO (alphabetic) code string for the payment's currency. [optional]
shop_currency string The ISO (alphabetic) code for the shop's currency. The shop displays all prices in this currency by default. [optional]
buyer_currency string The currency string of the buyer. [optional]
shipping_user_id int The numeric ID of the user to which the seller ships the order. [optional]
shipping_address_id int The numeric id identifying the shipping address. [optional]
billing_address_id int The numeric ID identifying the billing address of the buyer. [optional]
status string A string indicating the current status of the payment, most commonly "settled" or "authed". [optional]
shipped_timestamp int The transaction\'s shipping date and time, in epoch seconds. [optional]
create_timestamp int The transaction\'s creation date and time, in epoch seconds. [optional]
created_timestamp int The transaction\'s creation date and time, in epoch seconds. [optional]
update_timestamp int The date and time of the last change to the payment adjustment in epoch seconds. [optional]
updated_timestamp int The date and time of the last change to the payment adjustment in epoch seconds. [optional]
payment_adjustments \Swagger\Client\Model\AllOfPaymentPaymentAdjustmentsItems[] List of refund objects on an Etsy Payments transaction. All monetary amounts are in USD pennies unless otherwise specified. [optional]

[Back to Model list] [Back to API list] [Back to README]