api-payment-links

Get Payment Link by ID

Get Payment Link by ID

get/api/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/api/v1/payment-links/{paymentLinkId}
  • Auth: HTTP basic

Path parameters

paymentLinkIdstring required

paymentLinkId

Response

success

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 customer's delivery address.

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.

expiresAtstring

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' required
merchantIdstring

MerchantID is the identifier value of the merchant that owns this payment link

paymentLinkIdstring

PaymentLinkID is the identifier value of the payment link

redirectUrlstring

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

status'ACTIVE' | 'DISABLED' | 'EXPIRED' | 'PAID' | 'VOIDED' | 'REFUNDED'
urlstring

URL is the endpoint of the payment link, you can send this URL to your customer who wishes to make a payment.

Example response

{
  "cancelUrl": "https://www.beamcheckout.com/cancel?orderId=123",
  "expiresAt": "2025-04-08T03:58:28.343Z",
  "redirectUrl": "https://www.beamcheckout.com/success?orderId=123",
  "url": "https://pay.beamcheckout.com/merchantId/paymentLinkId"
}

Changes

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