SubscriptionBridge: recurring billing and subscription management system - Documentation

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.

====== API Field Reference ======





===== Overview =====

The API Field Reference contains a list of all the XML elements you will encounter in the API.  Additionally, it define the different data types used in each of those elements.



===== Elements =====



==== Username ====

The Username is part of your API Credentials.  This is not the Username you use to login to your Merchant Account.





==== Token ====

The Token is a HMAC/SHA hash made from your password and the current time separated by a pipe character.  By this method the token is time sensitive.  A token will remain valid for 2 minutes.  Your request must be made within two minutes after generating the token.

The format of the token before encryption is as follows:  XVWWVPRGab|2010-07-16T06:52:00

  * The first part "XVWWVPRGab" is the password.
  * The second "|" is the pipe. 
  * The third "2010-07-16T06:52:00" is the timestamp. It is important to note that the seconds of the timestamp must always be "00". The time is GMT.  To obtain the exact timestamp you may call the [[:developer_guide:call_reference:GetTimeRequest|GetTimeRequest]] method in the Subscription API.

After you form the token you must encrypt it using HMAC/SHA.  You will find encryption samples for PHP, .NET, and Classic ASP in the samples section.


===== Data Types =====

^ Name ^ Meaning ^
| string | alphanumeric characters |
| datetime | SB datatime format |