eBay
Connect
2020
Managed Payments
API Overview
June 2020
eBay Connect 2020
Agenda
Managed Payments Journey
Account API
Listings & Business Policies
Orders
Finances API & Trading: Account API
Post Transaction
Q & A
© 2020 eBay. All rights reserved.2
Our Payments Journey
© 2020 eBay. All rights reserved.3
2018
Announced we’d offer
managed payments
Launch
Full Rollout
2019
Introduced Google Pay and
PayPal at checkout
Expand managed payments
experience across eBay’s
global marketplace
2021
Journey will be largely
complete
2020
Managed payments
rolled out to select
US sellers
Introduced Apple
Pay at checkout
Expanded managed
payments offering to
Germany
Account API
Onboarding status, program enrollment & KYC
Account API: Onboarding Status & Payments Program
© 2020 eBay. All rights reserved.5
Check if the seller is in
Managed Payments
Check the seller's eligibility
Encourage them to
complete registration
Account API:
Managed Payments
Onboarding Status
GET
https://api.ebay.com/sell/account/v1/
payments_program/EBAY_US/EBAY_PAYMENTS/
onboarding
© 2020 eBay. All rights reserved.6
API consumers can:
• Check a seller’s eligibility for Managed
Payments
• Their current onboarding step
• Retrieve the URL to continue the flow on
eBay
{
"onboardingStatus": "ELIGIBLE_TO_ONBOARD",
"steps": [
{
"name": "1. businessType",
"status": "IN_PROGRESS",
"webUrl": "https://ebay.com/validate-user"
},
{
"name": "2. accountInfo",
"status": "NOT_STARTED"
},
{
"name": "3. payoutInfo",
"status": "NOT_STARTED"
},
{
"name": "4. review",
"status": "NOT_STARTED"
}
]
}
May
Account API:
Payments Program
GET
https://api.ebay.com/sell/account/v1/
payments_program/EBAY_US/EBAY_PAYMENTS
© 2020 eBay. All rights reserved.7
{
"marketplaceId": "EBAY_US",
"paymentProgramType": "EBAY_PAYMENTS",
"status": "OPTED_IN",
"wasPreviouslyOptedIn": "false"
}
May
Account API:
KYC
GET
https://api.ebay.com/sell/account/v1/kyc
© 2020 eBay. All rights reserved.8
{
"kycChecks": [
{
"dataRequired": "COMPANY_DETAILS",
"alert": "Update business info now.",
"remedyUrl":"https://www.ebay.com/sellerhub",
"dueDate": "2020-07-22T00:00:00.000Z",
"detailMessage": "Please update your business
info by July 22, 2020 to get your account back in good
standing."
},
{
"dataRequired": "BANK_DETAILS",
"alert": "Upload bank document now.",
"remedyUrl": "https://www.ebay.com/sellerhub",
"dueDate": "2020-08-01T00:00:00.000Z",
"detailMessage": "Please upload a bank document
by August 1, 2020 to get your account back in good
standing."
}
]
}
June
Listings & Business Policies
Changes in Listings & Business Policies
for Managed Payments
© 2020 eBay. All rights reserved.10
Trading API & Inventory API
No value is required for Payment Method or PayPal payment address. Any data provided
will be dropped.
Business Policies
No value is required for Payment Method or PayPal payment address. Any data provided
or in existing policies will be dropped.
Orders
Order details for purchased items
Order Payment
Methods
© 2020 eBay. All rights reserved.12
The paymentMethod field
in the getOrder methods
returns the payment method
used by a buyer to pay for
an order.
Fulfillment API: getOrder
EBAY value will be returned for all orders where payment is made on the eBay
platform. Other offline values may also be available.
Trading API: GetOrders
CheckoutStatus.PaymentMethod enum value will be CreditCard for
managed payments orders or CCAccepted for orders paid with eBay
Gift Card.
Fulfillment API
Designation
Description
EBAY
The buyer payment is managed by eBay, and payment can be considered
complete from seller’s perspective
CASHIER_CHECK
The buyer will pay with a cashier’s check or money order offline
PERSONAL_CHECK
The buyer will pay with a personal check
CASH_ON_PICKUP
The buyer will pay with cash
EFT
The buyer will pay with an off
-platform electronic funds transfer
Fulfillment API:
Get Order
GET
https://api.ebay.com/sell/fulfillment/v1/
order/1234567?fieldgroups=TAX_BREAKDOWN
Trading API getOrder and getItemTransactions
methods also return tax and recycling fee details.
© 2020 eBay. All rights reserved.13
{
"ebayCollectAndRemitTax": true,
"pricingSummary": {
...
"fee": {
"value": "6.0",
"currency": "USD"
}
},
"lineItems": [
{
"lineItemId": "6319232829195",
"taxes": [ {
"amount": {
"value": "24.33",
"currency": "USD"
},
"taxType": "STATE_SALES_TAX"
},
{
"amount": {
"value": "6.0",
"currency": "USD"
},
"taxType": "ELECTRONIC_RECYCLING_FEE"
}],
"ebayCollectAndRemitTaxes": [ {
"taxType": "STATE_SALES_TAX",
"amount": {
"value": "24.33",
"currency": "USD"
},
"collectionMethod": "NET"
},
{
"taxType": "ELECTRONIC_RECYCLING_FEE",
"amount": {
"value": "6.0",
"currency": "USD"
},
"collectionMethod": "NET"
}],
}
]
}
June
Finances API
Financial activity and fees
You Can Now Track Your Funds on eBay
Finances API enables sellers to get payout status and balances for financial and reconciliation operations.
© 2020 eBay. All rights reserved.15
eBay Payout
User Experience
© 2020 eBay. All rights reserved.16
Seller Funds Summary
eBay Payout
User Experience
© 2020 eBay. All rights reserved.17
Seller Funds Summary
Finances API:
Get Seller Funds Summary
GET
https://apiz.ebay.com/sell/finances/v1/
seller_funds_summary
© 2020 eBay. All rights reserved.18
{
"totalFunds": {
"value": "334.86",
"currency": "USD"
},
"processingFunds": {
"value": "198.6",
"currency": "USD"
},
"availableFunds": {
"value": "118.47",
"currency": "USD"
},
"fundsOnHold": {
"value": "17.79",
"currency": "USD"
}
}
October 2019
eBay Payout
User Experience
© 2020 eBay. All rights reserved.19
Payout Id
Payout Summary
Payouts
Finances API:
Get Payout
Summary
Retrieve cumulative values for payouts in a particular
state, or all states
GET
https://apiz.ebay.com/sell/finances/v1/
payout_summary
© 2020 eBay. All rights reserved.20
{
{
"payoutCount": 4,
"transactionCount": 10,
"amount": {
"value": "467.9",
"currency": "USD"
}
}
October 2019
Finances API:
Get Payouts
GET
https://apiz.ebay.com/sell/finances/v1/payout
© 2020 eBay. All rights reserved.21
{
"href": "https://apiz.ebay.com/sell/finances...",
"limit": 20,
"offset": 0,
"payouts": [
{
"payoutId": "57777854584",
"payoutStatus": "SUCCEEDED",
"payoutStatusDescription": "Funds sent",
"amount": {
"value": "317.93",
"currency": "USD"
},
"payoutDate": "2018-12-20T03:50:53.000Z",
"transactionCount": 7,
"payoutInstrument": {
"instrumentType": "BankAccount",
"nickname": "Chase",
"accountLastFourDigits": ”1234"
}
}
…
],
"total": 10
}
October 2019
Finances API:
Get Transactions
Retrieve one or monetary transactions. In this case,
'monetary transactions' include sales orders, buyer
refunds, and seller credits, along with their status
GET
https://apiz.ebay.com/sell/finances/v1/
transaction?filter=transactionType:
{SALE}&filter=transactionStatus:{FUNDS_ON_HOLD}
© 2020 eBay. All rights reserved.22
"transactions": [ {
"transactionId": "200009081244-9734029010!",
"orderId": "01-03955-36441",
"salesRecordReference": "441",
"buyer": {
"username": "rrpbuyer2"
},
"transactionType": "SALE",
"amount": {
"value": "207",
"currency": "USD"
},
"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",
"currency": "USD"
},
"bookingEntry": "CREDIT",
"transactionDate": "2018-11-09T02:38:40.000Z",
"transactionStatus": "FUNDS_ON_HOLD"}]
October 2019
Support for
Shipping Labels
© 2020 eBay. All rights reserved.23
eBay is billing sellers'
accounts directlyfor
eBay-generated shipping
labels when the seller is in
Managed Payments.
eBay shipping label fees
are returnedin the
getTransactionsand
getTransactionSummary
methods
Finances API:
Get Transactions
(Shipping Labels)
GET
https://apiz.ebay.com/sell/finances/v1/
transaction?filter=transactionType:
{SHIPPING_LABEL}
© 2020 eBay. All rights reserved.24
{
"href": "https://apiz.ebay.com/finances/v1...",
"limit": 20,
"offset": 0,
"transactions": [
{
"transactionId": "26-000-7350",
"orderId": "07-00010-54953",
"payoutId": "50077766689863",
"salesRecordReference": "0",
"buyer": {
"username": "rrp_buyer1"
},
"transactionType": "SHIPPING_LABEL",
"amount": {
"value": "1.87",
"currency": "USD"
},
"bookingEntry": "CREDIT",
"transactionDate": "2020-02-10T07:51:10.000Z",
"transactionStatus": "PAYOUT",
"transactionMemo": "Refund - underpaid postage
dispute accepted"
},
....
],
"total": 16
}
February
Finances API:
Dispute
Transactions
© 2020 eBay. All rights reserved.25
getTransactionsand
getTransactionSummary
methods now return dispute
information when adispute is
initiated by the buyer through
their payment provider
The new DISPUTE value in the TransactionTypeEnum type can be used
with the transactionType filter in a getTransactions or getTransactionSummary
method to limit transaction type to payment disputes.
Finances API
Fee Updates:
New Fields
© 2020 eBay. All rights reserved.26
Field
Description
amount
Amount by which seller’s virtual account balance is
adjusted.
For sellers with fees netted, fees are removed.
totalFeeBasisAmount
Amount paid to seller for order before eBay fees.
Includes price discounts & shipping.
totalFeeAmount
Amount of fees paid to eBay at time of order.
orderLineItems
Order line item level specific fees paid to eBay at time
of order.
Finances API Fee Updates:
Get Transactions
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]
© 2020 eBay. All rights reserved.27
{
"transactions": [
{
"transactionId": "200009081244-...",
"orderId": "01-03955-1111",
"salesRecordReference": "44",
"buyer": {
"username": "rrpbuyer2"
},
"transactionType": "SALE",
"amount": {
"value": “175",
"currency": "USD"
},
"totalFeeBasisAmount": {
"value": “200",
"currency": "USD"
},
"totalFeeAmount": {
"value": “25",
"currency": "USD"
},
"bookingEntry": "CREDIT",
"transactionDate": "2020-02-09T02:42:14.000Z",
"transactionStatus": "FUNDS_ON_HOLD"
"paymentsEntity": "eBay S.à r.l."
},
...
],
...
}
June
Finances API
Fee Updates:
Fee Types
© 2020 eBay. All rights reserved.28
Fee type
Description
BELOW_STANDARD_FEE
Fee for below standard performance
BELOW_STANDARD_SHIPPING_FEE
Fee on shipping for Below Standard
performance
FINAL_VALUE_FEE_PER_ORDER
Fixed FVF for fee
-netted sellers
FINAL_VALUE_FEE
Variable FVF for fee
-netted sellers
INTERNATIONAL_FEE
Fee for cross
-border orders
HIGH_ITEM_NOT_AS_DESCRIBED_FEE
Fee charged for buyer Significantly Not as
Described claim
HIGH_ITEM_NOT_AS_DESCRIBED_SHIPPING_FEE
Fee charged on shipping for buyer
Significantly Not as Described claim
OTHER_FEES
Any other fees assessed
The feeType fieldin
the getTransaction
methods returns the fee
type associated with the
OrderLineItem
Finances API Fee Updates:
Order Line Items
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’ = array of specific fees paid
to eBay at time of order
© 2020 eBay. All rights reserved.29
June
{
"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
<?xml version="1.0" encoding="utf-8"?>
<GetAccountRequest
xmlns="urn:ebay:apis:eBLBaseComponents">
...
<IncludeNettedEntries>boolean
</IncludeNettedEntries>
...
</GetAccountRequest>
© 2020 eBay. All rights reserved.30
<?xml version="1.0" encoding="utf-8"?>
<GetAccountResponse xmlns="urn:ebay:apis:eBLBaseComponents">
<AccountID>string</AccountID>
<FeeNettingStatus></FeeNettingStatus>
<AccountSummary>
<NettedTransactionSummary>
<TotalNettedChargeAmount currencyID="CurrencyCodeType">
AmountType (double)
</TotalNettedChargeAmount>
<TotalNettedCreditAmount currencyID="CurrencyCodeType">
AmountType (double)
</TotalNettedCreditAmount>
</NettedTransactionSummary>
</AccountSummary>
<AccountEntries>
<AccountEntry>
<DiscountDetail>
<Discount>
<DiscountType></DiscountType>
<Amount currencyID="CurrencyCodeType">
AmountType (double)
</Amount>
</Discount>
</DiscountDetail>
<Netted>boolean</Netted>
</AccountEntry>
...
</AccountEntries>
...
</GetAccountResponse >
June
Post Transaction
Disputes, Refunds, Returns, Cancellations
Fulfillment API: Payment Disputes
© 2020 eBay. All rights reserved.32
For sellers to manage buyer-initiated payment disputes
Payment dispute detail includes
• Current status of payment dispute
• Amount of the payment dispute
• Reason the payment dispute was opened
• Order and line items associated with the
payment dispute
• Seller response options if an action is
currently required on the payment dispute
• Details on the results of the payment dispute
if it has been closed
• Details on any evidence that was provided by
the seller
Sellers respond by
• Accepting the payment dispute
• Contesting
• Adding evidence and uploading
evidence files
• Updating evidence
Fulfillment API:
Get Payment Dispute
GET
https://api.ebay.com/sell/fulfillment/v1/
payment_dispute/7654321
© 2020 eBay. All rights reserved.33
{
"paymentDisputeId": "7654321",
"paymentDisputeStatus": "OPEN",
"revision": 2,
"reason": "FRAUD",
"orderId": "22-00009-21",
"buyerUsername": "ebaybuyer",
"openDate": "2019-10-03T20:07:17.000Z",
"respondByDate": "2019-10-09T06:59:59.000Z",
"lineItems": [
{
"itemId": "300013704248",
"lineItemId": "5712077022“
}
],
"amount": {
"value": "250.0",
"currency": "USD"
},
"sellerResponse": "SELLER_ACCEPT",
"buyerProvided": {
"note": "I have issue with the transaction"
}
}
March
Fulfillment API:
Contest Payment Dispute
POST
https://api.ebay.com/sell/fulfillment/v1/
payment_dispute/1234567/contest
© 2020 eBay. All rights reserved.34
{
"revision": 1,
"returnAddress": {
"primaryPhone": {
"number": "4081234567",
"countryCode": "US"
},
"fullName": "Joe Smith",
"addressLine1": ”2050 Hamilton Ave",
"addressLine2": "Apt 77",
"city": "Sunnyvale",
"stateOrProvince": "CA",
"postalCode": "94087-5527",
"country": "US"
}
}
March
Fulfillment API:
Seller Initiated
Refunds
© 2020 eBay. All rights reserved.35
Fulfillment API:
Seller Initiated Refund
POST
https://api.ebay.com/sell/fulfillment/v1/order/
{order_id}/issue_refund
© 2020 eBay. All rights reserved.36
June 2019
Request
{
"orderLevelRefundAmount": {
"value": "1.0",
"currency": "USD"
},
"reasonForRefund": "BUYER_CANCEL",
"comment": "Buyer changed mind and
requested cancellation of order"
}
Response
{
"refundId": "5000000453",
"refundStatus": "PENDING"
}
Post-Order API
© 2020 eBay. All rights reserved.37
All Post Order 1.0 features will be available for managed payment sellers.
Coming in July:
Refund summary with information on how the refund was funded
Ability to offer partial refunds via Post Order API when a buyer requests a return with the same
eligibility rules as in 1.0
Coming post-July:
Support for converted refund and held amounts based on FX conversion rates for Active CBT
transactions
Sell-side post order functionality as part of Fulfillment API
Post-Order API:
funding for refunds/returns
GET
https://api.ebay.com/post-
order/v2/inquiry/{inquiryId}
© 2020 eBay. All rights reserved.38
2019
"moneyMovementEntryList ": [
{
"date": {
"value": "2020-04-13T20:54:00.823Z"
},
"amount": {
"value": -24.0,
"convertedFromValue": -24.0,
"convertedFromCurrency": "USD",
"currency": "USD"
},
"type": "REFUND",
"fundingSource": {
"type": "CREDIT_CARD",
"brand": "VISA",
"memo": "Last four digits is 0007"
},
"fundingStatus": "FUNDED",
}
]
© 2020 eBay. All rights reserved.39
