Payments on Venmo have notes attached and can be made to other Venmo users, email addresses or phone numbers. Payments also include charges. For more information about the fields, click see below.
POST /payments
Pay or a charge an email, phone number or user.
Permissions:
Parameter | Description |
---|---|
access_token (required) | An authorized user's access token. |
phone, email or user_id (required) | Provide a valid US phone, email or Venmo User ID. |
note (required) | A message to accompany the payment. |
amount (required) | The amount you want to pay. To create a charge, use a negative amount. |
audience | The sharing setting for this payment. Possible values are 'public', 'friends' or 'private'. |
https://api.venmo.com/v1/payments
GET /payments
Get a list of the current user's most current payment and charges.
Permissions:
Parameter | Description |
---|---|
access_token (required) | An authorized user's access token. |
action | Filter for only payments or only charges. Possible values are 'pay' and 'charge'. |
actor | Filter for only transactions initiated by this user. You may provide multiple values, separated by commas. |
status | Filter for only transactions matching this status. You may provide multiple values, separated by commas. Possible values are 'settled', 'pending', 'failed', 'expired' and 'cancelled'. |
limit | Set the maximum number of transactions to return. |
after | Return only transactions made after this date. |
before | Return only transactions made before this date. |
https://api.venmo.com/v1/payments?access_token=<access_token>
GET /payments/:payment
Grabs information about a single payment or charge.
Permissions:
Parameter | Description |
---|---|
access_token (required) | An authorized user's access token. |
https://api.venmo.com/v1/payments/4?access_token=<access_token>
PUT /payments/:payment
Approve, deny, or cancel a payment request.
Permissions:
Parameter | Description |
---|---|
access_token (required) | An authorized user's access token. |
action (required) | Provide a value of 'approve', 'deny' if access token owner is the user who received the request, or 'cancel' if access token owner is the user who made the request. |
https://api.venmo.com/v1/payments/4
id | The id of a user. |
---|---|
status | The status of the payment. The possible values are 'settled', 'pending', 'failed', 'expired' and 'cancelled'. |
actor | A user object that describes the user that created the payment. |
fee | The fee amount if the payment has a fee attached to it. |
target | Stores information describing who the payment was sent to. The 'type' field corresponds to the kind of information used to specify the target of this payment and has three possible values: 'email', 'phone' and 'user'. The fields 'email' and 'phone' are used if a payment was made to a user that is not on Venmo. If the payment was made to someone's email address, that email address will be in the 'email' field. Similarly, if the payment was made to someone's phone number, that phone number will appear in the 'phone' field. If you pay a user id, or a phone number/email that is connected to a venmo account, the 'user' field will contain information about that user (the 'phone' and 'email' fields will be null). |
action | The type of payment, possible values are 'pay' and 'charge'. |
date_created | The datetime this payment was created. The datetime is in ISO 8601 format. |
date_completed | The datetime this payment was completed. The datetime is in ISO 8601 format. Payments with a 'pending' status will have a 'null' date_completed value. |
note | The note associated with the payment. |
audience | The sharing setting for this payment. Possible values are 'public', 'friends' and 'private'. |
medium | The medium the payment was created with. Possible values are 'ios', 'android', 'web' and 'api'. |
refund | Contains the refund payment if this payment expired or was refunded to the user. |