Payment Links

Get paid with a shareable link — no checkout integration required

A payment link is a hosted, shareable way to collect a payment without building a checkout — you send the customer a URL (by email, SMS, or chat), they land on a branded pay page, and the funds flow into the same account as your other card payments.

Common use cases

  • Collect a one-off payment when you don't have a storefront or app checkout
  • Send a "pay now" request by email or text
  • Take payment over the phone by texting a link instead of reading card numbers aloud

Send a payable request today

Until a standalone link endpoint is confirmed, create and send an invoice — the customer receives it and can pay online.

  1. Create the invoice with the amount and customer — see Invoicing.
  2. Send it with POST /checkout/v3/invoicereceipt.
  3. Track and reconcile payment against the invoice as usual.

Brand the payment page

You can control the look of the hosted payment page — fonts, colors, and logo — with the payment link settings. These apply to the page a customer sees when they pay.

Read the current settings

GET /paymentlinksetting?merchantId=1000157980

Retrieved via GET /paymentlinksetting (operationId PaymentLinkSetting_GetByMerchantId).

Update the settings

POST /paymentlinksetting?merchantId=1000157980

{
  "fontFamily": "Arial",
  "fontSize": 10,
  "fontColor": "#a72626",
  "backgroundColor": "#cb1515",
  "logo": "",
  "logoWidth": 0,
  "logoHeight": 0,
  "logoSize": 0
}

Saved via POST /paymentlinksetting (operationId PaymentLinkSetting_Create).

FieldTypeDescription
fontFamilystringFont family for text on the payment page.
fontSizeintegerFont size for text on the payment page.
fontColorstringText color (hex).
backgroundColorstringPage background color (hex).
logostringMerchant logo for the page.
logoWidthintegerLogo width.
logoHeightintegerLogo height.
logoSizeintegerOverall logo size.

See also



Did this page help you?
.readme-logo { display: none !important; }