Developer Portal

Payment Links API


The Payment Links API provides a simple method for suggesting payments by sharing a simple URL. Payment links are constructed by adding parameters to the base URL:

https://venmo.com/

Collect money for a trip, get paid back for tickets, or split food.

Parameters

txn

Use the txn query string variable to specify whether the transaction type is pay or charge (request).

Example link to request payment from the user kortina:

https://venmo.com/kortina?txn=charge

Example link to pay the user cassidoo:

https://venmo.com/cassidoo?txn=pay

amount

Use the amount query string variable to specify a transaction dollar amount. It can be a decimal value and should not use a $ character.

Example link to request $1 from the user iqram:

https://venmo.com/iqram?txn=charge&amount=1

Example link to pay the user possible $3.55:

https://venmo.com/possible?txn=pay&amount=3.55

note

Use the note query string variable to specify a personal payment note for a payment. The note should be URL-escaped. Example link to request $1 from the user kortina for a typo:

https://venmo.com/kortina?txn=charge&amount=1&note=for+a+typo

Example link to pay the user cassidoo $10 for tix:

https://venmo.com/cassidoo?txn=pay&amount=10&note=for+tix

share

Use the share query string variable to specify a default social network outside of Venmo to share on. Use "f" for Facebook.

Example link to request $1 from the user kortina for a bug and share on Facebook:

https://venmo.com/kortina?txn=charge&amount=1&note=for+a+bug&share=f

audience

Use the audience parameter to make your payment or request either public, private, or visible only to your friends.

Example link to pay a user shared privately:

https://venmo.com/kortina?txn=pay&amount=3&audience=private

recipients

Optionally specify recipients of a payment or charge by using the recipient's username as the path of the payment link URL. All of the above examples specify a recipient. Use / as the path to suggest a payment and let the user choose a recipient. Use the query string variable recipients to give a comma separated list of Venmo usernames, email addresses, or phone numbers of people to pay or charge.

Suggested payment with no recipient:

https://venmo.com/?txn=pay&amount=3.25&note=for+a+latte

Charge multiple recipients for dinner:

https://venmo.com/?txn=charge&amount=23.25&note=for+dinner&recipients=hamilton@venmo.com,646.863.9557,john