Managed Payments 管理支付服务 API 概览 免責信息本文內容用於解釋 ebay 平台的各項操作流程或平台政策 規則 本文中的任何 ( 包括隱含的 ) 觀點 建議 結論等僅供參考, 不構成對您的最終操作的建議 相關政策 規則的正式版本以各平台獨立公佈的為准 ebay 不就本文中的內容等對您的最終操作等做出任何保證或者承諾, 您據此做出的任何決策與 ebay 公司及編制人員無關
ebay 管理支付服务的旅程 2018 首次发表管理支付服务 支持 Apple Pay 支付方式 支持美国 2020 支持英国 澳洲 加拿大 2019 支持 Google Pay 和 PayPal 支付方式 支持德国 2021 支持大中华地区 法国意大利 西班牙
大中华区卖家注册和使用安排 部分卖家 3 月初启动注册 大部分卖家 3 月和 4 月收到注册的邀请 卖家账号激活 使用管理支付服务 所有卖家在 2021 年完成注册
卖家收款流程 买家下单 卖家 ebay 收款 收款 (payout) 每天 / 每周 Payoneer 账号 信用卡借记卡 Apple Pay Google Pay PayPal 扣除退款及费用
管理支付服务的好处 选择性 : 支持更多的买家支付方式 (payment options), 包括信用卡 借记卡 Apple Pay Google Pay 和 PayPal 便利性 : 在卖家专区提供卖家所需的一切 : 合并的费用明细 自定义报表 退款 / 退货及简化的卖家保护 如果卖家使用第三方工具, 这些工具的使用方式将会保持不变 简化的操作 : 款项 (payouts) 将直接存入卖家的 Payoneer 账户 卖家将获取唯一的订单编号 (order numbers), 以方便进行对账和退货处理 报表 : 卖家将可以从卖家专区下载并导出更新的报表, 并可使用相关数据将交易记录与卖家的 Payoneer 账户进行对账 API 集成 : 如果卖家使用与 ebay APIs 集成的第三方工具, 卖家可以更新这些集成工具, 以查看收款 (payout) 信息 专门的支持 : 在注册或使用管理支付服务过程中卖家都可以随时获得专门的客服支持
管理支付服务的 API Account API Finances API Fulfillment API 注册流程账号状态 支付记录收款信息退款及费用记录 卖家主动退款处理支付纠纷订单支付信息 Trading API 订单支付信息账单费用记录 Post Order API 售后退款支付方式和信息
Account API
获取管理支付服务的状态及进度 getpaymentsprogram - 用于确认卖家账号是否已经加入管理支付服务 GET https://api.ebay.com/sell/account/v1/payments _program/ebay_us/ebay_payments "paymentsprogramtype": "EBAY_PAYMENTS", "marketplaceid": "EBAY_US", "status": "OPTED_IN", "waspreviouslyoptedin": false
获取管理支付服务的状态及进度 getpaymentsprogramonboarding - 了解卖家账号在 onboarding 进程的进度 GET https://api.ebay.com/sell/account/v1/payments_ program/ebay_us/ebay_payments/onboarding "onboardingstatus": "ELIGIBLE_TO_ONBOARD", "steps": [ "name": "1. businesstype", "status": "COMPLETED", "name": "2. accountinfo", "status": "IN_PROGRESS", "weburl": "https://ebaypayonboardingweb.uk.vip.qa.ebay.com/val idate-user", "name": "3. payoutinfo", "status": "NOT_STARTED", "name": "4. review", "status": "NOT_STARTED" ]
KYC Know your customer getkyc: 具备管理支付服务资格的卖家通过这个请求可以了解需要提供哪些信息卖家可通过 remedyurl 链接解决有关问题 GET https://api.ebay.com/sell/account/v1/kyc kycchecks: [ ], [ ] "datarequired": BANK_DETAILS, "alert": "Upload bank document now.", "remedyurl": "https://www.ebay.com/sellerhub", "duedate": "06-15-2020 23:59:59", detailmessage : "Please upload a bank document by Jun 15, 2020 to get your account back in good standing." "datarequired": COMPANY_DETAILS, "alert": "Update business info now.", "remedyurl": "https://www.ebay.com/sellerhub", "duedate": "07-12-2020 23:59:59", "detailmessage": "Please update your business info by July 12, 2020 to get your account back in good standing."
刊登管理
创建和修改刊登 Trading API ReviseFixedPriceItem <Item> <PaymentMethods>PayPal</PaymentMethods> <PayPalEmailAddress>seller@company.com</PayPalEmailAddress> </Item> 不用填写或会被忽略
创建和修改刊登 ( 使用 Business Policy) Trading API ReviseFixedPriceItem <Item> <SellerProfiles> <SellerPaymentProfile> <PaymentProfileID>37967344010</PaymentPro fileid> <PaymentProfileName>PayPal01</PaymentProf ilename> </SellerPaymentProfile> </SellerProfiles> </Item> Inventory API CreateOffer/UpdateOffer "listingpolicies":, "paymentpolicyid": "37967344010", 不用填写或会被忽略 不用填写或会被忽略
查看管理支付服务订单 Trading API OrderArray.Order.CheckoutStatus.PaymentMethod CreditCard 以管理支付服务支付 CCAccepted 以礼物卡支付 余额以管理支付服务支付 <OrderArray> <Order> <CheckoutStatus> <PaymentMethod>CreditCard</PaymentMethod> <CheckoutStatus> </Order> </OrderArray>
查看管理支付服务订单 Fulfillment API orders.paymentsummary.payments.paymentmethod EBAY 以管理支付服务支付 "paymentsummary":... "payments": [ "paymentmethod": EBAY",......
订单的税款部分 Trading API 卖家可以通过 getorder, getorders 和 getitemtransactions 获取税款明细 <TaxDetails> <Imposition>SalesTax</Imposition> <TaxDescription>SalesTax</TaxDescription> <TaxAmount currencyid="usd">0.9</taxamount> <TaxOnSubtotalAmount currencyid="usd">0.9</taxonsub totalamount> <TaxOnShippingAmount currencyid="usd">0.0</taxonshi ppingamount> <TaxOnHandlingAmount currencyid="usd">0.0</taxonhan dlingamount> <CollectionMethod>NET</CollectionMethod> </TaxDetails>
订单的税款部分 Fulfillment API GET https://api.ebay.com/sell/fulfillment/v1/ order/1234567?fieldgroups=tax_breakdown 卖家需注意订单的税款明细不会在 Finances API 的 gettransaction 返回, 而是会在 Fulfillment API 的 getorder 或 getorders 中返回 ] "ebaycollectandremittax": true, "pricingsummary":... "fee": "value": "6.0",, "lineitems": [ "lineitemid": "6319232829195", "taxes": [ "amount": "value": "24.33",, "taxtype": "STATE_SALES_TAX", "amount": "value": "6.0",, "taxtype": "ELECTRONIC_RECYCLING_FEE" ], "ebaycollectandremittaxes": [ "taxtype": "STATE_SALES_TAX", "amount": "value": "24.33",, collectionmethod": "NET", "taxtype": "ELECTRONIC_RECYCLING_FEE", "amount": "value": "6.0",, "collectionmethod": "NET" ],
Finances API
卖家款项 getsellerfundssummary 用于获取卖家 ebay 账户的资金情况 GET https://apiz.ebay.com/sell/finances/v1/sell er_funds_summary "totalfunds": "value": "334.86",, "processingfunds": "value": "198.6",, "availablefunds": "value": "118.47",, "fundsonhold": "value": "17.79",
Finances API 费用款项 GET https://apiz.ebay.com/sell/finances/v1/ transaction?filter=transactiontype:sale& filter=transactiondate: [2020-05-01T00:00:01.000Z..2020-05- 10T00:00:01.000Z] orderlineitems = 在特定时间段内的 ebay 费用款项 "transactions": [... "orderlineitems" : "orderlineitemid" : "323438071240-0", "feebasisamount" : "currency": "EUR", "value": "150" "fees" : [ "feetype" : "Final_Value_Fee", "amount": "currency": "EUR", "value": "15, "feetype" :"Below_Standard_Fee", "amount" : "currency": "EUR", "value": "2,... ],...
Trading API 费用款项 getaccount 可以返回卖家账户费用清单上的每一笔记账用法 : 在请求 (request) 中设置 <IncludeNettedEntries> 为 true 响应 (response) 中的 <NettedTransactionSummary> 会返回所有 Fee 及 Credit 的款项 请求 (request) 响应 (response) <?xml version="1.0" encoding="utf-8"?> <GetAccountRequest xmlns="urn:ebay:apis:eblbasecomponents"> <IncludeNettedEntries>true</IncludeNettedEntri es> <AccountEntrySortType>AccountEntryCreatedT imeascending</accountentrysorttype> <AccountHistorySelection>LastInvoice</Acco unthistoryselection> </GetAccountRequest> <NettedTransactionSummary> <TotalNettedChargeAmount currencyid="usd">41.35</totalnettedchargeamount> <TotalNettedCreditAmount currencyid="usd">- 1.88</TotalNettedCreditAmount> </NettedTransactionSummary>
Trading API 费用款项 在每一笔记账费用的明细中也会出现 <Netted> 用以说明该笔记账费用是否从 Seller Payout 中扣除 <AccountEntry> <AccountDetailsEntryType>FinalValueFee</AccountDetailsEntryType> <Description>Final Value Fee</Description> <Date>2020-10-13T19:33:22.000Z</Date> <GrossDetailAmount currencyid="usd">0.13</grossdetailamount> <ItemID>223718812345</ItemID> <Memo>Applies to Total Amount of the Sale casss-54 Final amount: $1.09.</Memo> <NetDetailAmount currencyid="usd">0.13</netdetailamount> <RefNumber>3607080230123</RefNumber> <VATPercent>0</VATPercent> <Title>Poker Chip - 00 One chip (test)</title> <OrderLineItemID>223718812345-2465220289999</OrderLineItemID> <TransactionID>2465220289999</TransactionID> <OrderId>09-05888-12345</OrderId> <Netted>true</Netted> </AccountEntry>
外汇转换 ebay 管理支付卖家在跨国市场的订单交易及相关费用支持币种转换的新功能 "transactionid": "FEE-3621350170416", "payoutid": "5035087694", "salesrecordreference": "0", "transactiontype": "NON_SALE_CHARGE", "amount": "value": "1.67", "currency": "GBP", "convertedfromvalue": "2.25", "convertedfromcurrency": "USD", "exchangerate": "0.74213",
卖家收款设定 卖家的收入由 ebay 通过每一期的 Payout 形式发款可以在 Seller Hub 设置每天 (Daily) 或者每周 (Weekly) 作为发款周期
收款 (Payout) 的卖家专区界面
Finances API 收款概览 Get Payout Summary 获取特定状态的收款总额 GET https://apiz.ebay.com/sell/finances/v1/payout_summary "payoutcount": 4, "transactioncount": 10, "amount": "value": "467.9",
收款 (Payout) 记录
收款 (Payout) 记录 getpayouts 用于获取给卖家的每一笔打款信息 GET https://apiz.ebay.com/sell/finances/v1/payout "payouts": [ "payoutid": "5055155966", "payoutstatus": "SUCCEEDED", "payoutstatusdescription": "Funds sent", "amount": "value": "0.0",, "payoutdate": "2020-12-29T08:02:37.000Z", "lastattemptedpayoutdate": "2020-12- 29T08:09:31.000Z", "transactioncount": 6, "payoutinstrument": "instrumenttype": "BANK", "nickname": "AY - BoA", "accountlastfourdigits": "9088",
收款 (Payout) 记录 getpayout ID: 指定返回某一个 payout ID 的信息 GET https://apiz.ebay.com/sell/finances/v1/payout/ 5035087694 "payoutid": "5035087694", "payoutstatus": "SUCCEEDED", "payoutstatusdescription": "Funds sent", "amount": "value": "0.27",, "payoutdate": "2020-11-06T08:01:34.000Z", "lastattemptedpayoutdate": "2020-11- 12T04:28:20.000Z", "transactioncount": 21, "payoutinstrument": "instrumenttype": "BANK", "nickname": "AY - BoA", "accountlastfourdigits": "9088"
支付交易记录 Payment 的 Transaction 包括销售订单 退款 付费 支付纠纷等
Finances API Get Transactions Get Transactions 可根据支付交易的类别 状态和其他筛选方法获取支付交易记录 GET https://apiz.ebay.com/sell/finances/v1/transac tion?filter=transactiontype:sale&filter=tran sactionstatus:funds_on_hold "transactions": [ "transactionid": "200009081244-9734029010!", "orderid": "01-03955-36441", "salesrecordreference": "441", "buyer": "username": "rrpbuyer2", "transactiontype": "SALE", "amount": "value": "207",, "bookingentry": "CREDIT", "transactiondate": "2018-11-09T02:42:14.000Z", "transactionstatus": "FUNDS_ON_HOLD", "transactionid": "200009081244-9734028010!700822310", "orderid": "01-04966-46542", "salesrecordreference": "440", "buyer": "username": "rrpbuyer2", "transactiontype": "SALE", "amount": "value": "207",, "bookingentry": "CREDIT", "transactiondate": "2018-11-09T02:38:40.000Z", "transactionstatus": "FUNDS_ON_HOLD"]
例子展示
收款对应的支付交易 卖家专区
收款对应的支付交易 卖家专区
收款对应的支付交易 卖家专区
收款对应的支付交易 gettransactionpayoutid 获取跟指定 Payout ID 相关的所有支付交易 GET https://apiz.ebay.com/sell/finances/v1/transaction? filter=payoutid:5035087694 "transactions": [ "transactionid": "INTERNAL_TRANSFER- 6000072260MMAL2020-9", "orderid": "6000072260MMAL2020", "payoutid": "5035087694", "salesrecordreference": "0", "transactiontype": "ADJUSTMENT", "amount": "value": "0.27",, "bookingentry": "CREDIT", "transactiondate": "2020-10-31T18:06:54.000Z", "transactionstatus": "PAYOUT", "transactionmemo": "Fee Credits", "transactionid": "6141338438",..., "transactionid": "REFUND_CHARGE-5675189945",...,
收款对应的支付交易 Finances API bookingentry=credit 代表款项转入 ebay 账号
收款对应的支付交易 Finances API bookingentry=debit 代表款项从 ebay 账号向外转出
支付交易款项的区分 amount = totalfeebasisamount totalfeeamount amount: 已扣除掉费用的交易额, 会直接影响卖家账号的金额 totalfeebasisamount: 扣除费用前的交易额, 金额包含运费和折扣 totalfeeamount: 交易时 ebay 收取的费用 GET https://apiz.ebay.com/sell/finances/v1/transaction? filter=payoutid:5035087694 "transactiontype": "SALE", "amount": "value": "7.81",, "totalfeebasisamount": "value": "9.99",, "totalfeeamount": "value": "2.18",,
支付交易款项的区分 feetype 代表 ebay 收取费用的类别 当中,FINAL_VALUE_FEE_FIXED_PER_ORDER 是固定费用, 交易取消退款也不会被退回 GET https://apiz.ebay.com/sell/finances/v1/transact ion?filter=payoutid:5035087694... "marketplacefees": [ "feetype": "BELOW_STANDARD_FEE", "amount": "value": "0.54",, "feetype": "FINAL_VALUE_FEE", "amount": "value": "1.34",, "feetype": "FINAL_VALUE_FEE_FIXED_PER_ORDER", "amount": "value": "0.3",
支付交易款项的区分 原来的交易 "marketplacefees": [ "feetype": "BELOW_STANDARD_FEE", "amount": "value": "0.54",, "feetype": "FINAL_VALUE_FEE", "amount": "value": "1.34",, "feetype": "FINAL_VALUE_FEE_FIXED_PER_ORDER", "amount": "value": "0.3", 退款的交易 "marketplacefees": [ "feetype": "BELOW_STANDARD_FEE", "amount": "value": "0.54",, "feetype": "FINAL_VALUE_FEE", "amount": "value": "1.34", ]
支付交易款项的区分 费用类别 BELOW_STANDARD_FEE BELOW_STANDARD_SHIPPING_FEE FINAL_VALUE_FEE_PER_ORDER FINAL_VALUE_FEE INTERNATIONAL_FEE HIGH_ITEM_NOT_AS_DESCRIBED_FEE HIGH_ITEM_NOT_AS_DESCRIBED_SHIPPING_FEE OTHER_FEES 描述低于标准的账号表现费用低于标准的物流表现评级费用成交费固定费用成交费跨境销售费用物品與描述不符费用物品與描述不符物流费用其他费用
转账 (Transfer) Transfer: 当卖家的 Available Funds/Processing funds 不足以偿还 ebay 的款项时, 需要通过另一种支付方式 ( 如已认证登记的信用卡 ) 来转账一笔款项到卖家的 ebay 账户用来抵消这笔需支付的款项 GET https://apiz.ebay.com/sell/finances/v1/transaction?fil ter=transactiontype:transfer "transactions": [ "transactionid": "OTP-5065466084_5065556550", "salesrecordreference": "0", "transactiontype": "TRANSFER", "amount": "value": "6.49",, "bookingentry": "CREDIT", "transactiondate": "2021-01-27T00:49:10.000Z", "transactionstatus": "FUNDS_AVAILABLE_FOR_PAYOUT", "transactionmemo": "TRANSFER_FROM_DUE_TO_OTP", "transactionid": "OTP-5060748384_5060748385", "payoutid": "5055155966", "salesrecordreference": "0", "transactiontype": "TRANSFER",..., "transactionid": "6197007902", "payoutid": "5042098886", "salesrecordreference": "0", "transactiontype": "TRANSFER",...,
转账 (Transfer) gettranferid: 以 Transfer ID 来获取转账的明细 GET https://apiz.ebay.com/sell/finances/v1/transfer /OTP-5060748384_5060748385 "transferid": "OTP-5060748384_5060748385", "transactiondate": "2020-12-29T00:10:36.000Z", "fundingsource": "brand": "AMEX", "memo": "*4004", "type": "CREDIT_CARD", "transferamount": "value": "7.98",
支付纠纷 (Payment Dispute) 买家通过 ebay 以外的支付服务发起的支付纠纷 卖家可通过 Fulfillment API 进行处理 该订单的取消订单和退货请求会自动关闭 卖家也不可以在这时发起退款 支付纠纷 Payment Dispute 接受 Accept 提供证据 addevidence 争辩 Contest
支付纠纷 (Payment Dispute) getpaymentdisputesummary: 以支付纠纷状态 (i.e. Open/Close) 获取支付争议的信息 GET https://apiz.ebay.com/sell/fulfillment/v1/ payment_dispute_summary "paymentdisputesummaries": [ "paymentdisputeid": "5000250741", "paymentdisputestatus": "ACTION_NEEDED", "reason": "FRAUD", "orderid": "22-00009-21804", "opendate": "2019-10-03T20:07:17.000Z", "buyerusername": "mysandboxtestbuyer", "amount": "value": "250.0",, "paymentdisputeid": "5000250740", "paymentdisputestatus": "OPEN", "reason": "DUPLICATE_SPEND", "orderid": "25-00008-81155", "opendate": "2019-10-02T16:54:29.000Z", "respondbydate": "2019-10-09T06:59:59.000Z", "buyerusername": "mysandboxtestbuyer", "amount": "value": "250.0", ], "total": 5,
支付纠纷 (Payment Dispute) getpaymentdisputepayment_dispute_id: 以 disputeid 获取支付纠纷的明细信息 GET https://apiz.ebay.com/sell/fulfillment/v1/ payment_dispute/5000250742 "paymentdisputeid": "5000250742", "paymentdisputestatus": "OPEN", "reason": "FRAUD", "orderid": "22-00009-21804", "buyerusername": "mysandboxtestbuyer", "opendate": "2019-10-03T20:07:17.000Z", "respondbydate": "2019-10-09T06:59:59.000Z", "lineitems": [ "itemid": "300013704248", "lineitemid": "5712077022" ], "amount": "value": "250.0",, "sellerresponse": "SELLER_ACCEPT", "revision": 2, "buyerprovided": "note": "I have issue with the transaction"
卖家发起的退款 (Seller Initiated Refund) 通过 Fulfillment API 的 issuerefund, 卖家可发起退款 只有属于管理支付的刊登才可以使用这功能 Trading API 没有这项功能 请求 (request) POST https://api.ebay.com/sell/fulfillment/v1/order/ 23-03522-31852/issue_refund "orderlevelrefundamount": "value": "1.0",, "reasonforrefund": "BUYER_CANCEL", "comment": "Buyer changed mind and requested cancellation of order" 响应 (response) "refundid": "5000000453", "refundstatus": "PENDING"
卖家发起的退款 (Seller Initiated Refund) 卖家也可以对订单中的部分商品发起退款 请求 (request) POST https://api.ebay.com/sell/fulfillment/v1/order/24-03528- 54027/issue_refund "refunditems": [ "refundamount": "value": "1.0",, "lineitemid": "10017944789024" ], "reasonforrefund": "BUYER_CANCEL", "comment": "Buyer requested cancellation of one line item in the order" 响应 (response) "refundid": "5000000458", "refundstatus": "PENDING"
Post Order API
Post Order API 的更新 调用 getcancellation getinquiry getcase 以及 getreturn 时, 返回结果中 netchargeamount 代表因退款而向卖家记账扣除交易费用后的金额 GET https://api.ebay.com/postorder/v2/cancellation/5000357515?fieldgroups=full "actualrefunddetail": "actualrefund": "totalamount": "value": 34.67,, "feecreditamount": "value": 3.53,, "netchargeamount": "value": 40.38, "convertedfromvalue": 31.14, "convertedfromcurrency": "USD", "currency": "CAD", "exchangerate": "1.29665", "outstandingamount": "value": 0, "currency": "CAD",
Post Order API 的更新 退款和退货的支付资金来源 GET https://api.ebay.com/post-order/v2/inquiry/inquiryid "moneymovemententrylist": [ "date": "value": "2020-04-13T20:54:00.823Z", "amount": "value": -24.0, "convertedfromvalue": -24.0, "convertedfromcurrency": "USD",, "type": "REFUND", "fundingsource": "type": "CREDIT_CARD", "brand": "VISA", "memo": "Last four digits is 0007", "fundingstatus": "FUNDED", ]
测试
测试环境 生产环境 沙箱环境
展示
有问题怎么样? 参考 API 文档 浏览大中华开发者专区 技术支持电邮 特别需求可联系客户经理安排
ebay API 文档 https://developer.ebay.com/managed-payments
大中华开发者专区网站 https://www.ebay.cn/developer
谢谢 如果有什么疑问, 可以发到以下电邮 : DL-eBay-CBT-API-Managed-Payments@ebay.com
Q&A