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.
In order to test out the functionality of your app we provide you with a sandbox testing environment allowing you to make payments and charges without affecting your balance. The sandbox test user has a user id 145434160922624933, email "vaultpay@vaultpay.org" and phone "15555555555". All requests must be made to https://sandbox-api.vaultpay.org/v1.
Make a successful payment to a user.
Permissions:
| Parameter | Description |
|---|---|
| access_token (required) | Your own access token used for authentication to the API. |
| user_id | 145434160922624933 |
| vaultpay@vaultpay.org | |
| phone | 15555555555 |
| note (required) | A message to accompany the payment. |
| amount (required) | 0.10 |
POST https://sandbox-api.vaultpay.org/v1/payments{
"data": {
"balance": 9.90,
"payment": {
"id": "1322585332520059420",
"status": "settled",
"note": "Rock Climbing!",
"amount": 0.10,
"action": "pay",
"date_created": "2013-12-30T19:40:57.865985",
"date_completed": "2013-12-30T19:40:57.865985",
"audience": "public",
"target": {
"type": "user",
"phone": null,
"email": null,
"user": {
"username": "testuser",
"first_name": "Test",
"last_name": "User",
"display_name": "Test User",
"about": "Long walks on the beach, sunsets, testing",
"profile_picture_url": "https://vaultpaypics.appspot.com/u/v3/s/6ecc7b37-5c4a-49df-b91e-3552f02dc397",
"id": "145434160922624933",
"date_joined": "2013-02-10T21:58:05"
}
},
"actor": {
"username": "delavara",
"first_name": "Cody",
"last_name": "De La Vara",
"display_name": "Cody De La Vara",
"about": "So happy",
"profile_picture_url": "https://vaultpaypics.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"
}
}
}This typically happens when a user has not provided a funding source to their account and there is not enough funds in their balance to cover the payment.
Permissions:
| Parameter | Description |
|---|---|
| access_token (required) | Your own access token used for authentication to the API. |
| user_id | 145434160922624933 |
| vaultpay@vaultpay.org | |
| phone | 15555555555 |
| note (required) | A message to accompany the payment. |
| amount (required) | 0.20 |
POST https://sandbox-api.vaultpay.org/v1/payments{
"data": {
"balance": 10.00,
"payment": {
"id": "1322585332520059420",
"status": "failed",
"note": "Rock Climbing!",
"amount": 0.20,
"action": "pay",
"date_created": "2013-12-30T19:40:57.865985",
"date_completed": "2013-12-30T19:40:57.865985",
"audience": "public",
"target": {
"type": "user",
"phone": null,
"email": null,
"user": {
"username": "testuser",
"first_name": "Test",
"last_name": "User",
"display_name": "Test User",
"about": "Long walks on the beach, sunsets, testing",
"profile_picture_url": "https://vaultpaypics.appspot.com/u/v3/s/6ecc7b37-5c4a-49df-b91e-3552f02dc397",
"id": "145434160922624933",
"date_joined": "2013-02-10T21:58:05"
}
},
"actor": {
"username": "delavara",
"first_name": "Cody",
"last_name": "De La Vara",
"display_name": "Cody De La Vara",
"about": "So happy",
"profile_picture_url": "https://vaultpaypics.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"
}
}
}A payment will be in pending status if it is sent to a phone number or email address that is not yet registered with Vault Pay. You need to pass in either email or phone.
Permissions:
| Parameter | Description |
|---|---|
| access_token (required) | Your own access token used for authentication to the API. |
| user_id | 145434160922624933 |
| vaultpay@vaultpay.org | |
| phone | 15555555555 |
| note (required) | A message to accompany the payment. |
| amount (required) | 0.30 |
POST https://sandbox-api.vaultpay.org/v1/payments{
"data": {
"balance": 9.70,
"payment": {
"id": "1322585332520059420",
"status": "pending",
"note": "Rock Climbing!",
"amount": 0.30,
"action": "pay",
"date_created": "2013-12-30T19:40:57.865985",
"date_completed": null,
"audience": "public",
"target": {
"type": "email",
"phone": null,
"email": "nonvaultpayuser@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://vaultpaypics.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"
}
}
}When a charge is made to a trusted friend then it is automatically completed.
Permissions:
| Parameter | Description |
|---|---|
| access_token (required) | Your own access token used for authentication to the API. |
| user_id | 145434160922624933 |
| vaultpay@vaultpay.org | |
| phone | 15555555555 |
| note (required) | A message to accompany the payment. |
| amount (required) | -0.10 |
POST https://sandbox-api.vaultpay.org/v1/payments{
"data": {
"balance": 10.10,
"payment": {
"id": "1322585332520059420",
"status": "settled",
"note": "Rock Climbing!",
"amount": -0.10,
"action": "charge",
"date_created": "2013-12-30T19:40:57.865985",
"date_completed": "2013-12-30T19:40:57.865985",
"audience": "public",
"target": {
"type": "user",
"phone": null,
"email": null,
"user": {
"username": "testuser",
"first_name": "Test",
"last_name": "User",
"display_name": "Test User",
"about": "Long walks on the beach, sunsets, testing",
"profile_picture_url": "https://vaultpaypics.appspot.com/u/v3/s/6ecc7b37-5c4a-49df-b91e-3552f02dc397",
"id": "145434160922624933",
"date_joined": "2013-02-10T21:58:05"
}
},
"actor": {
"username": "delavara",
"first_name": "Cody",
"last_name": "De La Vara",
"display_name": "Cody De La Vara",
"about": "So happy",
"profile_picture_url": "https://vaultpaypics.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"
}
}
}All non-trust charges require approval by the target user.
Permissions:
| Parameter | Description |
|---|---|
| access_token (required) | Your own access token used for authentication to the API. |
| user_id | 145434160922624933 |
| vaultpay@vaultpay.org | |
| phone | 15555555555 |
| note (required) | A message to accompany the payment. |
| amount (required) | -0.20 |
POST https://sandbox-api.vaultpay.org/v1/payments{
"data": {
"balance": 10.00,
"payment": {
"id": "1322585332520059420",
"status": "pending",
"note": "Rock Climbing!",
"amount": -0.20,
"action": "charge",
"date_created": "2013-12-30T19:40:57.865985",
"date_completed": null,
"audience": "public",
"target": {
"type": "email",
"phone": null,
"email": "nonvaultpayuser@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://vaultpaypics.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"
}
}
}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.