lighthouse

Get total charges, refunds, total amount and average per transaction

Used in Today and Insight sections

get/lighthouse/v1/ui/dashboard/revenue

Request

  • Base URL: https://api.beamcheckout.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.beamcheckout.com/lighthouse/v1/ui/dashboard/revenue
  • Auth: OAuth 2 (implicit, authorization URL "")

Query parameters

currency'THB'

filter on transactions whose currency exactly matches this value

txnTime_gtestring

filter on transactions whose txnTime is greater than or equal to this value

txnTime_ltestring

filter on transactions whose txnTime is less than or equal to this value

paymentMethodType_instring[]

paymentMethodType_in as comma separated values (e.g. 'CREDIT_CARD,CREDIT_CARD_INSTALLMENTS')

Headers

x-beam-merchant-idstring required

x-beam-merchant-id

Response

success

averageAmountinteger
currency'THB'
totalAmountinteger

Changes

No recorded changes to this operation across all 1 revision of this API.