Query parameters
Pass parameters directly to StreamPayments Links
Passing parameters helps developers auto-fill StreamPayments checkout pages from other data sources like customer forms to offer a better user experience.
Simply pass through the parameters and values in the format and the StreamPayments Link page will populate those fields with the values posted.
Example Paylink URL with Parameters
Standard Pay Link
https://streampay.me/pay/639af31b6d5b18b4425378cd
Pay Link with parameters:
https://streampay.me/pay/639af31b6d5b18b4425378cd?email=jane@hel.io&fullName=Jane Smith&discordUsername=Janesmith#0001&twitterUsername=@janesmithhelio&streetNumber=1&street=Acacia Avenue&deliveryAddress=Townsville&city=Bigtown&state=South&areaCode=W1 1AA&phoneNumber=07973999999&productValue=9
Parameters and Values Available
email=
Email Address
A valid email address is required
discordUsername=
Discord Username or ID
A valid Discord username or ID. If ID is used then this cannot be used with our Discord bot which only accepts Username currently
twitterUsername=
Twitter Username
Standard Twitter name required with @
fullName=
Full Username
Real name of a customer
streetNumber=
Street Number
Street number of a property
street=
Street Name
Street Name
deliveryAddress=
Optional Street Name
Optional Street Name
city=
City Name
City Name
state=
State Name
State or Region Name
areaCode=
Area Code
Area or Postal Code
phoneNumber=
Phone Number
Phone Number in local format
productValue=
Custom Entry
Set using 'Additional Information' setting in paylink setup to capture custom data like shoe size
Adding all the values will populate the StreamPayment's Link page as follows
Last updated