CreatePaymentLinkDto

  • Restrict which rails the payer may use. Omit to offer everything available. Listing a rail never guarantees it — one that is not supported for this account simply will not be offered.

  • Amount due in USD. Omit to let the payer decide how much to send — the difference between an invoice and a tip jar.

  • Details to ask the payer for, on top of whatever the rail already needs. A mobile-money payer is asked for their number either way.

    values
    emailphonenamebilling_address
  • Display currency for the amount. Settlement is always USD.

  • Longer note shown under the title.

  • When the link stops accepting payment, ISO-8601.

  • What the payer is buying, itemised on the page. Display only — we do not price, tax or ship them. Omit amount and the items add up to it.

    Properties: 3
  • How many times this link may be paid. Omit for unlimited. Set 1 for a single-use invoice.

  • Arbitrary key/value data you control.

  • Where to send the payer after a successful payment.

  • Your own reference, echoed back on webhooks.

  • Shown to the payer as the headline.