lighthouse

Gets a Payment Link

Gets a Payment Link

get/lighthouse/v1/payment-links/{paymentLinkId}

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

Path parameters

paymentLinkIdstring required

paymentLinkId

Headers

x-beam-merchant-idstring required

x-beam-merchant-id

Response

success

createdAtstring
createdBystring
expiresAtstring
feeType'TRANSACTION_FEE' | 'SERVICE_FEE'
linkType'SINGLE' | 'MULTIPLE'
paymentLinkIdstring
redirectUrlstring
status'ACTIVE' | 'DISABLED' | 'EXPIRED' | 'PAID' | 'VOIDED' | 'REFUNDED'
updatedAtstring
updatedBystring

Changes

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