Our vaultpay 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 vaultpay as a payment method in your checkout experience, visit https://getmobix.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.
For more information about the fields, see below.
GET /me
Email, phone and balance will return non-null if the access token has proper permissions.
Permissions:
| Parameter | Description |
|---|---|
| access_token (required) | An authorized user's access token |
https://api.vaultpay.org/v1/me?access_token=<access_token>{
"data": {
"balance": 102.3,
"user": {
"username": "delavara",
"first_name": "Cody",
"last_name": "De La Vara",
"display_name": "Cody De La Vara",
"is_friend": false,
"friends_count": 165,
"about": "So happy!",
"email": null,
"phone": null,
"profile_picture_url": "https://vaultpaypics.appspot.com/u/v3/s/6ecc7b37-5c4a-49df-b91e-3552f02dc397",
"id":"1088551785594880949",
"date_joined": "2013-02-10T21:58:05"
}
}
}GET /users/:user_id
Retrieves information about a single user
Permissions:
| Parameter | Description |
|---|---|
| access_token (required) | An authorized user's access token |
https://api.vaultpay.org/v1/users/:user_id?access_token=<access_token>{
"data": {
"username": "delavara",
"first_name": "Cody",
"last_name": "De La Vara",
"display_name": "Cody De La Vara",
"is_friend": false,
"friends_count": 165,
"about": "So happy",
"email": null,
"phone": null,
"profile_picture_url": "https://vaultpaypics.appspot.com/u/v3/s/6ecc7b37-5c4a-49df-b91e-3552f02dc397",
"id":"1088551785594880949",
"date_joined": "2013-02-10T21:58:05"
}
}GET /users/:user_id/friends
Retrieves a user's friends
Permissions:
| Parameter | Description |
|---|---|
| access_token (required) | Your own access token used for authentication to the API |
| before | Returns user ids less than this id |
| limit | Limits the number of friends returned |
https://api.vaultpay.org/v1/users/:user_id/friends?access_token=<access_token>{
"pagination": {
"next": "https://api.vaultpay.org/v1/users/1088551785594880949/friends?after=161568197181440668&limit=3"
},
"data": [
{
"username": "kortina",
"about": "make a joyful sound, la da da da",
"last_name": "Kortina",
"display_name": "Andrew Kortina",
"first_name": "Andrew",
"profile_picture_url": "https://vaultpaypics.appspot.com/u/v5/s/25f9c7a0-5d5c-4988-8737-a3278d78ae42",
"id": "145434160922624167"
},
{
"username": "iqram",
"about": "Frisbee enthusiast",
"last_name": "magdon-ismail - organic",
"display_name": "Iqram magdon-ismail - organic",
"first_name": "Iqram",
"profile_picture_url": "https://vaultpaypics.appspot.com/u/v11/s/6c3740ad-26bd-475c-9da2-7cb3fd7591da",
"id": "145436736225280235"
},
{
"username": "staub",
"about": "phonewalletbaby",
"last_name": "Staub",
"display_name": "Andrew Staub",
"first_name": "Andrew",
"profile_picture_url": "https://vaultpaypics.appspot.com/u/v1/s/0b4b85ab-a72b-4326-a887-5bf7a08ff445",
"id": "152710129123328341"
},
{
"username": "azeem",
"about": "No Short Bio",
"last_name": "Ansar",
"display_name": "Azeem Ansar",
"first_name": "Azeem",
"profile_picture_url": "https://vaultpaypics.appspot.com/u/v1/s/2b797ba9-1bd5-41b8-a5a9-f133e128f234",
"id": "161568197181440668"
}
]
}| id | The id of a user. |
|---|---|
| first_name | The user's first name. |
| last_name | The user's last name. |
| display_name | The best name to display, usually the first and last name together or a business name. |
| username | The user's username. |
| date_joined | The date the user joined Vault Pay. |
| profile_picture_url | A URL to the user's profile picture. |
| about | The user's bio. |
| The user's email, if the access token has access_email scope, otherwise is null. | |
| phone | The user's phone number, if the access token has access_phone scope, otherwise is null. |
| is_friend | Boolean designating whether the authorized user is friends with this user. This will be 'null' if the authorized user is looking themselves up. |
| friends_count | The number of friends the user has on Vault Pay. |
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@vaultpay.org.