question

xtiansimon avatar image
xtiansimon asked xtiansimon answered

Looking for Credit Card Surcharge fee

Need to get Clover sales data for customer who charges their guests 3-4% fee to cover the additional cost of CC Processing. (see example of customer receipt in first screenshot below). The CC Fee value is not returned as expected (see second screenshot below)


GET /v3/merchants/{customer}/orders?
       filter=clientCreatedTime%3E=1706522400000
       &filter=clientCreatedTime%3C=1706608800000
       &expand=lineItems.discounts,
                         lineItems.modifications,
                         payments,
                         refunds,
                         discounts,
                         serviceCharge
       &limit=100
       &offset=0
       HTTP/1.1


1. If this is not the correct endpoint, which endpoint should we use?

2. What parameter will return the Surcharge value?

Related post here in the community:
Card transaction fees? (2021), the result three years ago was a simple, "This information is not provided via the API." Not entirely clear what "this" refers to in this statement. I hope cc surcharge is available.

FIGURE: Customer screenshot of Credit card surcharge

receipt.png


FIGURE: Result from the orders endpoint

results.png

-->

REST API
receipt.png (22.4 KiB)
results.png (155.4 KiB)
2 comments
10 |2000
Toggle Comment visibility. Current Visibility: Viewable by all users

Up to 2 attachments (including images) can be used with a maximum of 512.0 KiB each and 1.0 MiB total.

parquet76 avatar image parquet76 commented ·

That community post seems unrelated, I think the poster is asking about fees the merchant is charged per transaction, not the service charge the merchant passes along to the consumer. Your request seems ok, any difference if you fetch a single order (with same expansions)? Are you sure you checked the entire response and are looking at the correct order?

0 Likes 0 ·
xtiansimon avatar image xtiansimon parquet76 commented ·
@parquet76 Sorry for the late response. I'm not working in a green field development environment, so I don't get to change the parameters easily.
0 Likes 0 ·

1 Answer

·
xtiansimon avatar image
xtiansimon answered xtiansimon edited

After further effort the Credit Card Surcharge was found!

Yayhooray!

https://api.clover.com/v3/merchants/{customer}/payments?
    filter=createdTime%3E=1706522400000
    &filter=createdTime%3C=1706608800000
    &expand=cardTransaction,
        serviceCharge
        &limit=100
        &offset=0

But it wasn't easy--`serviceCharge` is not listed in the expansions. Is the documentation, Get all payments, in need of updating?

Expandable fields to display additional nested information: [tender, germanInfo, lineItemPayments, cardTransaction, dccInfo, refunds, transactionInfo, externalReferenceId, oceanGatewayInfo, taxRates, additionalCharges, appTracking, paymentAttributes, order]
10 |2000
Toggle Comment visibility. Current Visibility: Viewable by all users

Up to 2 attachments (including images) can be used with a maximum of 512.0 KiB each and 1.0 MiB total.

Write an Answer

Hint: Notify or tag a user in this post by typing @username.

Up to 2 attachments (including images) can be used with a maximum of 512.0 KiB each and 1.0 MiB total.

Welcome to the
Clover Developer Community