API ReferenceWooCommerceSDKssoonWebhookssoon

Payments

Read cashback settings (plugin)

GET/pay/settings/cashback

Plugin/storefront helper. Returns the merchant's current cashback percentage and limits so product pages can display the correct rate.

  • Returns percentage as an integer (e.g. 3 for 3%) and percentage_decimal as a fraction (0.03). Use whichever your renderer prefers.

Authentication

Requires an API key in the X-API-Key header.

GET/pay/settings/cashback
curl "https://api.trevi.cash/pay/settings/cashback" --header "X-API-Key: $BTPAY_API_KEY"