How to Start a Payment Request from an External Source
Note: A Podium developer account is not required to use Deep Linking.
Not Compatible with the Podium 2.0 App on Android
With the launch of the Podium 2.0 App, Android devices will not support deep linking.
The Podium mobile app supports payment requests started from an external website, CRM, App, etc. through the use of a Podium app link.
New payment request links begin with:
podium://payments/new
Additional query strings are required to configure the new payment request, for example:
podium://payments/new?name=John%20Smith&[email protected]&amount=500&description=Apples&amount=327&description=Peaches
Parameters
Required
| Parameter | Description | Examples |
|---|---|---|
| name | The customer's full name. | name=John%20Smith |
| phoneOrEmail | Phone number or email of the customer that will receive the payment request. | [email protected] |
Optional
| Parameter | Description | Examples |
|---|---|---|
| invoiceNumber | The invoice number for the transaction (any string; default is empty) | invoiceNumber=1234invoiceNumber=WB16032invoiceNumber=EWQWDD |
| Invoice Items | A list of items to include on the invoice with an amount (in pennies) and description for each item. | amount=<number in pennies>&description=<description>Creating an invoice for John Smith (email is [email protected]) with two items (Apples for $5.00 and Peaches for $3.27): amount=500&description=Apples& amount=327&description=Peaches |
| paymentType | The type of transaction. “request” or “charge”, default is “request”. | paymentType=request |
| scheduleType | The desired schedule for the transaction. Supported options are the following: - “oneTime”: A one-time transaction (default) - “ongoing”: A recurring payment with no specified end - “installments”: The current invoice is broken up into a specified number of payments. | scheduleType=oneTime |
| frequency | The gap between recurring payments. Supported options are the following: - “weekly”: First payment happens today; subsequent payments will take place on the specified day of the week. - “monthly”: First payment happens today; subsequent payments will take place on the specified day of the month. - “quarterly”: First payment happens today; subsequent payments will take place every three months from today. - “yearly”: First payment happens today; subsequent payments will take place each year from today. | frequency=weekly |
| repeatOn | An integer representing which day a recurring payment should be repeated on. - If frequency is “weekly”, valid numbers are from 1 - 7 - If frequency is “monthly”, valid numbers are from 1 - 31 - This should not be included when frequency is “quarterly” or “yearly”. | repeatOn=10 |
| numberOfPayments | The number of times this payment will be repeated. | numberOfPayments=5 |
| dueDate | The date the payment is due, in ISO 8601 format. Only applies when the paymentType is “request” and when the scheduleType is “oneTime”. | dueDate=2022-01-06T18:41:54Z |
Examples
New Payment Request using All Parameters
- name: John Smith
- phoneOrEmail: [email protected]
- invoiceNumber: 12345
- Invoice Items:
- Parts for $725
- Installation for $25
- paymentType: “request”
- scheduleType: “installments”
- frequency: “monthly”
- repeatOn: “10” (meaning, I want the first to happen today, and the second to happen on the 10th next month)
- numberOfPayments: 5 (this means that the total of $750 will be in 5 payments of $150 each)
- dueDate: Not available on an installment plan.
podium://payments/new?name=John%20Smith&[email protected]&invoiceNumber=12345&amount=72500&descripton=Parts&amount=2500&description=Installation&paymentType=request&scheduleType=installments&frequency=monthly&repeatOn=10&numberOfPayments=5.
Updated over 3 years ago