Difference between revisions of "API/biller integration"

From Webcamwiz
Jump to: navigation, search
(Created page with "= Preface = This document describes how to upsell to your webcam white label site by providing billing information for your user. The billing information should be provided a...")
 
Line 2: Line 2:
 
This document describes how to upsell to your webcam white label site by providing billing information for your user.
 
This document describes how to upsell to your webcam white label site by providing billing information for your user.
  
The billing information should be provided as an encrypted parameter set as will be described in this document and is specific and different for each billing service.
+
The billing information should be provided as an encrypted JSON object as will be described in this document
 +
 
 +
This JSON data collection is specific and different for each billing service.
  
 
Currently Paycom and CCBill payment services are supported.
 
Currently Paycom and CCBill payment services are supported.
 +
 +
This encrypted object may be added to any link or promo tool you are currently using to send traffic to your white label, it should be added to the URL as the "bs" parameter.
 +
 +
== Parameters Encryption & Encoding ==
 +
The billing information provided on the link should be encrypted and encoded by performing the following steps:
 +
* Encryption method: AES
 +
* Cipher: CBC
 +
* Padding Mode: Zeros
 +
* Vector: 146, 64, 191, 111, 23, 3, 113, 119, 231, 121, 252, 112, 79, 32, 114, 156
 +
* Key: Provided key (the key is a private key provided to you)
 +
* Encoding: UTF8
 +
* Parameter Construction:
 +
** Construct the required JSON data object for the specific payment service.
 +
** Encrypt the JSON object.
 +
** Convert the encrypted string to Base64 string.
 +
** URL encode the result string.
 +
 +
Like this:
 +
 +
'''''HttpURLEncode(ConvertToBase64String(AESEncryption(JSON)))'''''
 +
 +
== CCBill billing information ==
 +
{|
 +
|'''Name'''
 +
|'''Type'''
 +
|'''Notes'''
 +
|-
 +
|tokeninfo
 +
|string
 +
|CCBill upsell token info
 +
|-
 +
|picode
 +
|string
 +
|The original product code purchased by the user
 +
|-
 +
|memberid
 +
|string
 +
|The original member id of the user you are trying to upsell.
 +
|-
 +
|email
 +
|string
 +
|valid e-mail address of the user
 +
|-
 +
|username
 +
|String
 +
|The username of the user. (4-25 characters)
 +
|-
 +
|Password
 +
|String
 +
|The password of the user. (4-25 characters)
 +
|-
 +
|sendemail
 +
|Int
 +
|0/1 – send to the user welcome e-mail with his login details.
 +
|-
 +
|timestamp
 +
|Long
 +
|Obtain the current Unix timestamp (seconds since midnight, January 1 st , 1970) in UTC
 +
|-
 +
|cultureid
 +
|Int
 +
 +
1 English
 +
 +
2 Italian
 +
 +
3 French
 +
 +
4 German
 +
 +
5 Spanish
 +
 +
6 Portuguese
 +
 +
13 Hindi
 +
 +
15 Dutch
 +
 +
18 Russian
 +
 +
21 Swedish
 +
 +
25 Arabic
 +
|Set the default culture of the user
 +
 +
The default value is English.
 +
|}
 +
 +
== Paycom billing information ==

Revision as of 16:16, 16 December 2014

Preface

This document describes how to upsell to your webcam white label site by providing billing information for your user.

The billing information should be provided as an encrypted JSON object as will be described in this document

This JSON data collection is specific and different for each billing service.

Currently Paycom and CCBill payment services are supported.

This encrypted object may be added to any link or promo tool you are currently using to send traffic to your white label, it should be added to the URL as the "bs" parameter.

Parameters Encryption & Encoding

The billing information provided on the link should be encrypted and encoded by performing the following steps:

  • Encryption method: AES
  • Cipher: CBC
  • Padding Mode: Zeros
  • Vector: 146, 64, 191, 111, 23, 3, 113, 119, 231, 121, 252, 112, 79, 32, 114, 156
  • Key: Provided key (the key is a private key provided to you)
  • Encoding: UTF8
  • Parameter Construction:
    • Construct the required JSON data object for the specific payment service.
    • Encrypt the JSON object.
    • Convert the encrypted string to Base64 string.
    • URL encode the result string.

Like this:

HttpURLEncode(ConvertToBase64String(AESEncryption(JSON)))

CCBill billing information

Name Type Notes
tokeninfo string CCBill upsell token info
picode string The original product code purchased by the user
memberid string The original member id of the user you are trying to upsell.
email string valid e-mail address of the user
username String The username of the user. (4-25 characters)
Password String The password of the user. (4-25 characters)
sendemail Int 0/1 – send to the user welcome e-mail with his login details.
timestamp Long Obtain the current Unix timestamp (seconds since midnight, January 1 st , 1970) in UTC
cultureid Int

1 English

2 Italian

3 French

4 German

5 Spanish

6 Portuguese

13 Hindi

15 Dutch

18 Russian

21 Swedish

25 Arabic

Set the default culture of the user

The default value is English.

Paycom billing information