CreatePaymentLinkDto
- allowedType: array of "crypto" or "fiat"enum
_rails 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.
- amountType: numbermin:0.01
Amount due in USD. Omit to let the payer decide how much to send — the difference between an invoice and a tip jar.
- collectType: array of stringenum
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.
valuesemailphonenamebilling_address - currencyType: string
Display currency for the amount. Settlement is always USD.
- descriptionType: stringmax length:500
Longer note shown under the title.
- expiresType: string
_at When the link stops accepting payment, ISO-8601.
- lineType:
_items Properties: 3What the payer is buying, itemised on the page. Display only — we do not price, tax or ship them. Omit
amountand the items add up to it. - maxType: number
_uses min:1How many times this link may be paid. Omit for unlimited. Set 1 for a single-use invoice.
- metadataType: object
Arbitrary key/value data you control.
- redirectType: string
_url Where to send the payer after a successful payment.
- referenceType: stringmax length:255
Your own reference, echoed back on webhooks.
- titleType: stringmax length:140
Shown to the payer as the headline.