Pre-populate Payments Portal

The following guide provides instructions for users on how to leverage URL parameters to pre-populate invoice data in a web application. This functionality enhances user experience by automatically populating relevant information when users access the invoice creation page through a URL.

Pre-populating Invoice Data with URL Parameters:

To pre-populate invoice data using URL parameters, you can include specific keys as parameters in the query string of your URL. The following keys are supported by the Invoice URL:

• accountUid
• channelIdentifier
• channelType
• contactName
• invoiceNumber
• isRecurringRequest
• recurring
• lineItems
• locationUid
• paymentFlow

See the table below for more information.

Encoding Key Values:

It's essential to encode the keys when using URL parameters. To accomplish this, ensure you utilize the URLSearchParams object for key encoding.

Example Link:

https://pay.podium.com/portal?accountUid=e5e1e036-70ec-4ab6-8808-401a218f510b&channelIdentifier=john%40gmail.com&channelType=email&contactName=John&entryPoint=modal&invoiceNumber=test+invoice&lineItems=%255B%257B%2522amount%2522%253A100%252C%2522description%2522%253A%2522test%2520description%2522%252C%2522requiresShipping%2522%253Atrue%257D%255D&locationUid=5d86ee1c-a9b2-56d2-b1c7-01d304bf245e&paymentFlow=request&recurring=%257B%2522interval%2522%253A%2522WEEKLY%2522%252C%2522month%2522%253A5%252C%2522date%2522%253A8%252C%2522dayOfWeek%2522%253A4%252C%2522totalToSend%2522%253A%2522%2522%252C%2522ends%2522%253A0%252C%2522endDate%2522%253Anull%252C%2522isSubscription%2522%253Afalse%257D

Field Usage and Types:

The table below lists the supported keys, their usage in the URL parameters, and their corresponding data types:

Example: Pre-filled Invoice Data