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

PaymentTemplate

Overview

A payment template for a user.

Fields

Field Visibility Level Permission Scope Type Description
payment_template_id public none int The numeric ID for this payment template
allow_bt public none boolean True if the seller accepts bank transfers for payment
allow_check public none boolean True if the seller accepts checks for payment
allow_mo public none boolean True if the seller accepts money order payments
allow_other public none boolean True if the seller accepts other payments
allow_paypal public none boolean True if the seller accepts paypal
allow_cc public none boolean True if the seller accepts credit cards
paypal_email private listings_r string The users paypal email address.
name private listings_r string The name of the seller.
first_line private listings_r string The first line of the seller's address.
second_line private listings_r string The second line of the seller's address.
city private listings_r string The seller's city.
state private listings_r string The seller's state.
zip private listings_r string The seller's zip code.
country_id private listings_r int The seller's country.
user_id private listings_r int The user's numeric ID.
listing_payment_id public none int Provided for backward compatibility to ListingPayment. This will return the same value as payment_template_id.

Associations

Association Visibility Level Permission Scope Type Description
Country private listings_r Country The full Country record of the shop's country.
User private listings_r User The User that owns this payment template

Methods

findShopPaymentTemplates

Method Name findShopPaymentTemplates
Synopsis Retrieves the PaymentTemplate associated with the Shop
HTTP Method GET
URI /shops/:shop_id/payment_templates
Parameters
Name Required Default Type
shop_id Y   shop_id_or_name
Requires OAuth N
Permission Scope none

createShopPaymentTemplate

Method Name createShopPaymentTemplate
Synopsis Creates a new PaymentTemplate
HTTP Method POST
URI /shops/:shop_id/payment_templates
Parameters
Name Required Default Type
shop_id Y   shop_id_or_name
allow_check N   boolean
allow_mo N   boolean
allow_other N   boolean
allow_paypal N   boolean
allow_cc N   boolean
paypal_email N   string
name N   string
first_line N   string
second_line N   string
city N   string
state N   string
zip N   string
country_id N   int
Requires OAuth Y
Permission Scope listings_w

updateShopPaymentTemplate

Method Name updateShopPaymentTemplate
Synopsis Updates a PaymentTemplate
HTTP Method PUT
URI /shops/:shop_id/payment_templates/:payment_template_id
Parameters
Name Required Default Type
shop_id Y   shop_id_or_name
allow_check N   boolean
allow_mo N   boolean
allow_other N   boolean
allow_paypal N   boolean
allow_cc N   boolean
paypal_email N   string
name N   string
first_line N   string
second_line N   string
city N   string
state N   string
zip N   string
country_id N   int
payment_template_id Y   int
Requires OAuth Y
Permission Scope listings_w

findAllUserPaymentTemplates

Method Name findAllUserPaymentTemplates
Synopsis Retrieves a set of PaymentTemplate objects associated to a User.
HTTP Method GET
URI /users/:user_id/payments/templates
Parameters
Name Required Default Type
user_id Y   user_id_or_name
Requires OAuth Y
Permission Scope listings_r

Open API v3New

Your developer account