Create Payment Link

Create Payment Link that can be used to pay for merchants

post/api/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/api/v1/payment-links
Auth: HTTP basic

Request body

cancelUrlstring

CancelURL if provided will render a cancel button on the UI which can redirect the customer back to

collectDeliveryAddressboolean

CollectDeliveryAddress is a setting to see if the checkout page will ask for delivery address. True means the page will ask for the delivery address. Defaults to false.

collectPhoneNumberboolean

CollectPhoneNumber is a setting to see if the checkout page will ask for the customer's phone number. True means the page will ask for the customer's phone number. Defaults to true.

expiresAtstring date-time

ExpiresAt is the timestamp where after this point in time the payment link will expire and will not accept payment. Optional, with null value meaning no expiry for the payment link.

feeType'TRANSACTION_FEE' | 'SERVICE_FEE'

redirectUrlstring

RedirectURL is the endpoint that the customer will be directed to after payment has succeeded.

Example request

{
  "cancelUrl": "https://www.beamcheckout.com/cancel?orderId=123",
  "expiresAt": "2025-04-08T03:58:28.343Z",
  "order": {
    "description": "1 Cookies Box",
    "netAmount": 10000,
    "referenceId": "order#10001"
  },
  "redirectUrl": "https://www.beamcheckout.com/success?orderId=123"
}

Response

success

idstring

ID is the identifier value of the payment link created

urlstring

URL is the endpoint of the created payment link

Changes

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