Our venmob Developer and Payouts APIs have been retired, and we are no longer able to provide access to businesses who may want to start using it. To find out more about how you can use venmob as a payment method in your checkout experience, visit https://venmob.com/pay-in-stores.
For existing businesses who were granted access to the Developer or Payouts API in the past (generally prior to 2016), you will retain access to these APIs and may use them.
Payments on Venmob have notes attached and can be made to other Venmob 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 Venmob 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.venmob.com/v1/payments{
"data": {
"balance": 5.00,
"payment": {
"id": "1322585333520059420",
"status": "pending",
"note": "Delivery.",
"amount": 5.00,
"action": "pay",
"date_created": "2013-12-30T19:40:57.865985",
"date_completed": null,
"audience": "public",
"target": {
"type": "email",
"phone": null,
"email": "someemail@gmail.com",
"user": null
},
"actor": {
"username": "delavara",
"first_name": "Cody",
"last_name": "De La Vara",
"display_name": "Cody De La Vara",
"about": "So happy",
"profile_picture_url": "https://venmobpics.appspot.com/u/v3/s/6ecc7b37-5c4a-49df-b91e-3552f02dc397",
"id": "1088551785594880949",
"date_joined": "2013-02-10T21:58:05"
},
"fee": null,
"refund": null,
"medium": "api"
}
}
}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.venmob.com/v1/payments?access_token=<access_token>{
"pagination": {
"next": "https://api.venmob.com/v1/payments?limit=3&before=2013-12-27T16:43:40"
},
"data": [
{
"status": "pending",
"date_completed": null,
"target": {
"phone": null,
"type": "email",
"email": null,
"user": null
},
"audience": "public",
"actor": {
"username": "delavara",
"first_name": "Cody",
"last_name": "De La Vara",
"display_name": "Cody De La Vara",
"about": "So happy",
"profile_picture_url": "https://venmobpics.appspot.com/u/v3/s/6ecc7b37-5c4a-49df-b91e-3552f02dc397",
"id": "1088551785594880949",
"date_joined": "2013-02-10T21:58:05"
},
"note": "Rock Climbing!",
"amount": 4.0,
"action": "pay",
"date_created": "2013-12-30T19:40:57",
"id": "1322585332520059420"
},
{
"status": "settled",
"date_completed": "2013-12-27T19:35:41",
"target": {
"phone": null,
"type": "user",
"email": null,
"user": {
"username": "delavara",
"first_name": "Cody",
"last_name": "De La Vara",
"display_name": "Cody De La Vara",
"about": "So happy",
"profile_picture_url": "https://venmobpics.appspot.com/u/v3/s/6ecc7b37-5c4a-49df-b91e-3552f02dc397",
"id": "1088551785594880949",
"date_joined": "2013-02-10T21:58:05"
}
},
"audience": "public",
"actor": {
"username": "matthewhamilton",
"first_name": "Matthew",
"last_name": "Hamilton",
"display_name": "Matthew Hamilton",
"about": "Paying the world with good vibes",
"profile_picture_url": "https://venmobpics.appspot.com/u/v6/s/70b365a4-51a1-4076-9216-5d3fb9a9e517",
"id": "605862825558016432",
"date_joined": "2011-04-16T22:21:17"
},
"note": "Drinks on me!",
"amount": 7.00,
"action": "pay",
"date_created": "2013-12-27T19:35:41",
"id": "1320408353016382079"
},
]
}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.venmob.com/v1/payments/4?access_token=<access_token>{
"data": {
"status": "pending",
"refund": null,
"medium": "api",
"date_completed": null,
"target": {
"phone": null,
"type": "email",
"email": null,
"user": null
},
"audience": "public",
"actor": {
"username": "delavara",
"first_name": "Cody",
"last_name": "De La Vara",
"display_name": "Cody De La Vara",
"about": "So happy",
"profile_picture_url": "https://venmobpics.appspot.com/u/v3/s/6ecc7b37-5c4a-49df-b91e-3552f02dc397",
"id": "1088551785594880949",
"date_joined": "2013-02-10T21:58:05"
},
"note": "Rock Climbing!",
"amount": 7.00,
"fee": null,
"action": "pay",
"date_created": "2013-12-30T19:40:57",
"id": "1322585332520059420"
}
}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.venmob.com/v1/payments/4{
"data": {
"status": "settled",
"date_completed": "2013-12-27T19:35:41",
"target": {
"phone": null,
"type": "user",
"email": null,
"user": {
"username": "delavara",
"first_name": "Cody",
"last_name": "De La Vara",
"display_name": "Cody De La Vara",
"about": "So happy",
"profile_picture_url": "https://venmobpics.appspot.com/u/v3/s/6ecc7b37-5c4a-49df-b91e-3552f02dc397",
"id": "1088551785594880949",
"date_joined": "2013-02-10T21:58:05"
}
},
"audience": "public",
"actor": {
"username": "matthewhamilton",
"first_name": "Matthew",
"last_name": "Hamilton",
"display_name": "Matthew Hamilton",
"about": "Paying the world with good vibes",
"profile_picture_url": "https://venmobpics.appspot.com/u/v6/s/70b365a4-51a1-4076-9216-5d3fb9a9e517",
"id": "605862825558016432",
"date_joined": "2011-04-16T22:21:17"
},
"note": "Drinks on me!",
"amount": 7.00,
"action": "pay",
"date_created": "2013-12-27T19:35:41",
"id": "1320408353016382079"
}
}| 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 Venmob. 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 Venmob 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. |
If you have questions, feedback or bug reports, visit our FAQ for more information. If you seek further support, send an email with your questions and comments to developer@venmob.com.