0.1.0 • Published 8 years ago
vspapi v0.1.0
VSPAPI facilitates the use of the vSecure Processing web services within a Node application. To use these services you will need to setup your own developer account at vSP Developer Portal and sign a non-disclosure agreement.
Setting Up a Context
Setting up the vspapi is very simple. Once your have signed up with the developer portal you will be assigned your own GID and other assorted values which are used to setup the initail context for the api.
Context Parameters
| Property | Type | Required | Description |
|---|---|---|---|
| gid | String | ✔ | This value is unique to the developer. One must be created for you by vSecure Processing. |
| platform | String | Optionally override the default "Buypass" platform value. | |
| url | String | Optionally override the default base URL for the vSP web services | |
| tid | String | Optionally set a Terminal ID ("01" by default) | |
| appId | String | ✔ | The ID of your application. This value may be assigned to you by vSP |
| userId | String | ✔ | The user ID of the developer as registered with vSP |
Example Usage
var api = require('vspapi');
var ctx = {
gid:"xxxxxxxxxxxxxxx",
appId:"xxxxx",
userId:"info@someplace.com"
};
api.config(ctx);See Also
- api.createToken(data, callback)
- api.deleteToken(data, callback)
- api.queryToken(data, callback)
- api.updateToken(data, callback)
- api.processPayment(data, callback)
- api.voidTransaction(data, callback)
- api.processRefund(data, callback)
- api.processAuth(data, callback)
- api.processAuthCancel(data, callback)
- api.processCaptureOnly(data, callback)