lighthouse

Creates a new Payment Link

Creates a new Payment Link

post/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 "")

Headers

x-beam-merchant-idstring required

x-beam-merchant-id

Request body

expirystring

Expiry if provided Beam will not allow further checkout attempts to be made after the provided timestamp. Only supported in linkType single, ignored otherwise.

linkType'SINGLE' | 'MULTIPLE' required
paymentLinkIdstring

PaymentLinkID specifies the ID of the link. The linkType must be 'multiple' only and it is optional. Must be alphanum with max length of 12.

redirectUrlstring

RedirectURL if provided Beam will redirect the customer to this URL on successful checkout.

Example request

{
  "order": {
    "description": "1 Cookies Box",
    "netAmount": 10000,
    "referenceID": "order#10001"
  }
}

Response

success

linkType'SINGLE' | 'MULTIPLE'
merchantIdstring
paymentLinkIdstring

Changes

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