Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Etsy Payment API

The Payment API from Etsy — 3 operation(s) for payment.

Etsy Payment API is one of 28 APIs that Etsy publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Payment. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, authentication docs, and rate-limit docs.

This API exposes 3 operations across 3 paths, and defines 6 schemas. It is described by OpenAPI 3.0.2, at version 3.0.0.

Requests are made against a single base URL, https://openapi.etsy.com.

3 operations 3 paths 6 schemas 3 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.2
API Version
3.0.0
Base URL
https://openapi.etsy.com
Authentication
API Key, OAuth 2.0
Terms of Service
Resource Areas
1

Authentication & Security 2

Etsy Payment API declares 2 security schemes for authenticating requests. An API key is passed in the header as x-api-key (api_key). It supports OAuth 2.0 (oauth2) using the authorizationCode flow, exposing 20 scopes. By default, every request must be authenticated.

  • api_key — Every request to a v3 API endpoint must include this data in the format keystring:sharedsecret. Your keystring and shared secret are available on the [Your App…
  • oauth2 — Open API v3 supports authenticating via OAuth 2.0. More information about Etsy's specific implementation of OAuth2 can be found [here](/documentation/essential…

Paths & Operations 3

Across 3 paths, the API surfaces 3 operations — 3 GET. Each is listed below with its method, path, parameters, and response codes.

Payment 3
GET
/v3/application/shops/{shop_id}/payment-account/ledger-entries/payments
Etsy Get Payment Account Ledger Entry Payments
getPaymentAccountLedgerEntryPayments 2 params → 200400403401500
GET
/v3/application/shops/{shop_id}/receipts/{receipt_id}/payments
Etsy Get Shop Payment by Receipt Id
getShopPaymentByReceiptId 2 params → 200404403400401500
GET
/v3/application/shops/{shop_id}/payments
Etsy Get Payments
getPayments 2 params → 200404403400401500

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are Payment (26 properties), PaymentAdjustment (15 properties), PaymentAdjustmentItem (9 properties), Money (3 properties). Each schema is shown below with its type and property counts.

PaymentAdjustmentItem
object
A payment adjustment line item for a payment adjustment.
9 properties
Payments
object
Represents several payments made with Etsy Payments. All monetary amounts are in USD pennies unless otherwise specified.
2 properties
ErrorSchema
object
1 property 1 required
PaymentAdjustment
object
Represents a refund, which applies to a prior Etsy payment. All monetary amounts are in USD pennies unless otherwise specified.
15 properties
Payment
object
Represents a payment made with Etsy Payments. All monetary amounts are in USD pennies unless otherwise specified.
26 properties
Money
object
A representation of an amount of money.
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

etsy-payment-api-openapi.yml Raw ↑

Other APIs Etsy publishes across the network.

Etsy Open API v3 Webhooks
Etsy BuyerTaxonomy API
Etsy Ledger Entry API
Etsy Other API
Etsy Review API
Etsy SellerTaxonomy API
Etsy Shop API
Etsy Shop HolidayPreferences API
Etsy Shop ProcessingProfiles API
Etsy Shop ProductionPartner API
Etsy Shop Receipt API
Etsy Shop Receipt Transactions API