lighthouse

List Charges in a view specific to UI requirements

List Charges in a view specific to UI requirements

get/lighthouse/v1/ui/charges

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

Query parameters

chargeId_likestring

filter on transactions whose chargeId partially matches this value

sourceId_likestring

filter on transactions whose sourceId partially matches this value

chargeSourceCreatedBystring

filter on transactions whose chargeSourceCreatedBy exactly matches this value

chargeCreatedAt_ltestring

filter on charges whose createdAt is less than or equal to this value

chargeCreatedAt_gtestring

filter on charges whose createdAt is greater than or equal to this value

chargeTransactionTime_ltestring

filter on charges whose transactionTime is less than or equal to this value

chargeTransactionTime_gtestring

filter on charges whose transactionTime is greater than or equal to this value

offsetinteger

offset

limitinteger

limit

querystring

filters on charges whose chargeId or referenceId contains with this value (case sensitive)

chargeSource_instring[]

chargeSource_in as comma separated values (e.g. 'API,PAYMENT_LINK')

displayStatus_instring[]

displayStatus_in as comma separated values (e.g. 'FAILED,PENDING')

paymentMethodType_instring[]

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

Headers

x-beam-merchant-idstring required

x-beam-merchant-id

Response

success

totalCountinteger

Changes

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