All URIs are relative to https://openapi.etsy.com
| Method | HTTP request | Description |
|---|---|---|
| getPaymentAccountLedgerEntryPayments | GET /v3/application/shops/{shop_id}/payment-account/ledger-entries/payments | |
| getPayments | GET /v3/application/shops/{shop_id}/payments | |
| getShopPaymentByReceiptId | GET /v3/application/shops/{shop_id}/receipts/{receipt_id}/payments |
Payments getPaymentAccountLedgerEntryPayments(shopId, ledgerEntryIds)
<div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><span class=\"wt-badge wt-badge–notificationPrimary wt-bg-slime-tint wt-mr-xs-2\">General Release</span><a class=\"wt-text-link\" href=\"https://github.com/etsy/open-api/discussions\" target=\"_blank\" rel=\"noopener noreferrer\">Report bug</a></div><div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><p class=\"wt-text-body-01 banner-text\">This endpoint is ready for production use.</p></div> Get a Payment from a PaymentAccount Ledger Entry ID, if applicable
// Import classes:
//import com.etsy.infrastructure.*
//import com.etsy.models.*
val apiInstance = PaymentApi()
val shopId : kotlin.Long = 789 // kotlin.Long | The unique positive non-zero numeric ID for an Etsy Shop.
val ledgerEntryIds : kotlin.collections.List<kotlin.Long> = // kotlin.collections.List<kotlin.Long> |
try {
val result : Payments = apiInstance.getPaymentAccountLedgerEntryPayments(shopId, ledgerEntryIds)
println(result)
} catch (e: ClientException) {
println("4xx response calling PaymentApi#getPaymentAccountLedgerEntryPayments")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling PaymentApi#getPaymentAccountLedgerEntryPayments")
e.printStackTrace()
}
| shopId | kotlin.Long| The unique positive non-zero numeric ID for an Etsy Shop. | | | Name | Type | Description | Notes | | ————- | ————- | ————- | ————- | | ledgerEntryIds | kotlin.collections.List<kotlin.Long>| | |
Configure api_key: ApiClient.apiKey[“x-api-key”] = “” ApiClient.apiKeyPrefix[“x-api-key”] = “” Configure oauth2: ApiClient.accessToken = “”
Payments getPayments(shopId, paymentIds)
<div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><span class=\"wt-badge wt-badge–notificationPrimary wt-bg-slime-tint wt-mr-xs-2\">General Release</span><a class=\"wt-text-link\" href=\"https://github.com/etsy/open-api/discussions\" target=\"_blank\" rel=\"noopener noreferrer\">Report bug</a></div><div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><p class=\"wt-text-body-01 banner-text\">This endpoint is ready for production use.</p></div> Retrieves a list of payments from a shop identified by `shop_id`. You can also filter results using a list of payment IDs.
// Import classes:
//import com.etsy.infrastructure.*
//import com.etsy.models.*
val apiInstance = PaymentApi()
val shopId : kotlin.Long = 789 // kotlin.Long | The unique positive non-zero numeric ID for an Etsy Shop.
val paymentIds : kotlin.collections.List<kotlin.Long> = // kotlin.collections.List<kotlin.Long> | A comma-separated array of Payment IDs numbers.
try {
val result : Payments = apiInstance.getPayments(shopId, paymentIds)
println(result)
} catch (e: ClientException) {
println("4xx response calling PaymentApi#getPayments")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling PaymentApi#getPayments")
e.printStackTrace()
}
| shopId | kotlin.Long| The unique positive non-zero numeric ID for an Etsy Shop. | | | Name | Type | Description | Notes | | ————- | ————- | ————- | ————- | | paymentIds | kotlin.collections.List<kotlin.Long>| A comma-separated array of Payment IDs numbers. | |
Configure api_key: ApiClient.apiKey[“x-api-key”] = “” ApiClient.apiKeyPrefix[“x-api-key”] = “” Configure oauth2: ApiClient.accessToken = “”
Payments getShopPaymentByReceiptId(shopId, receiptId)
<div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><span class=\"wt-badge wt-badge–notificationPrimary wt-bg-slime-tint wt-mr-xs-2\">General Release</span><a class=\"wt-text-link\" href=\"https://github.com/etsy/open-api/discussions\" target=\"_blank\" rel=\"noopener noreferrer\">Report bug</a></div><div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><p class=\"wt-text-body-01 banner-text\">This endpoint is ready for production use.</p></div> Retrieves a payment from a specific receipt, identified by `receipt_id`, from a specific shop, identified by `shop_id`
// Import classes:
//import com.etsy.infrastructure.*
//import com.etsy.models.*
val apiInstance = PaymentApi()
val shopId : kotlin.Long = 789 // kotlin.Long | The unique positive non-zero numeric ID for an Etsy Shop.
val receiptId : kotlin.Long = 789 // kotlin.Long | The numeric ID for the [receipt](/documentation/reference#tag/Shop-Receipt) associated to this transaction.
try {
val result : Payments = apiInstance.getShopPaymentByReceiptId(shopId, receiptId)
println(result)
} catch (e: ClientException) {
println("4xx response calling PaymentApi#getShopPaymentByReceiptId")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling PaymentApi#getShopPaymentByReceiptId")
e.printStackTrace()
}
| shopId | kotlin.Long| The unique positive non-zero numeric ID for an Etsy Shop. | | | Name | Type | Description | Notes | | ————- | ————- | ————- | ————- | | receiptId | kotlin.Long| The numeric ID for the receipt associated to this transaction. | |
Configure api_key: ApiClient.apiKey[“x-api-key”] = “” ApiClient.apiKeyPrefix[“x-api-key”] = “” Configure oauth2: ApiClient.accessToken = “”