lighthouse

Get the merchant's effective package

Get the currently effective package for the merchant, exposing payout and bank-account settings used by Lighthouse.

get/lighthouse/v1/packages/effective

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/packages/effective
  • Auth: OAuth 2 (implicit, authorization URL "")

Headers

x-beam-merchant-idstring required

x-beam-merchant-id

Response

Package

allowActivateBankAccountboolean
allowOnDemandPayoutboolean
idstring
payoutFrequency'DAILY' | 'EVERYDAY' | 'WEEKLY' | 'NOT_APPLICABLE'

Changes

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