lighthouse

Lists the merchant's Payment Links

Lists the merchant's Payment Links

get/lighthouse/v1/payment-links

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

Query parameters

linkType'SINGLE' | 'MULTIPLE' required

linkType

querystring

filters on payment links whose paymentLinkId or referenceId contains with this value (case sensitive)

status_instring[]

filters on payment links whose status matches on of these values

updatedAt_gtestring

filters on payment links whose updatedAt is greater than or equal to this time

updatedAt_ltestring

filters on payment links whose updatedAt is less than or equal to this time

offsetinteger

offset

limitinteger

limit

Headers

x-beam-merchant-idstring required

x-beam-merchant-id

Response

success

countinteger

TODO: change to TotalCount type int64 on techdebt clean up

Changes

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