- Supports Buying Coins: GetBuyCoinsInfo()
- Supports Direct Purchase: GetBuyDirectInfo()
UltimatePay PayVault Provider
Setting up your UltimatePay account
- Sign up for UltimatePay on http://developer.playspan.com/
- When you've signed up and have been approved, you will receive your Merchant Configuration Document. This contains all the information you need to enter into the Player.IO systems.
- You are also supposed to fill out the Merchant Configuration Document and send it back to UltimatePay. You are free to fill it out as you like, but the Secure Url for postbacks must be set to:
http://api.playerio.com/payvault/ultimatepay/postback
Configuring PayVault on Player.IO
- Enable UltimatePay in the PayVault admin panel for your game
- Enter the Merchant Code, Login, Admin Password and Secret Phrase in their respective fields. You can find the values in the Merchant Configuration Document you received from UltimatePay.
- If you want to allow coin purchases through UltimatePay, you need to add one or more coin price points also.
Each price point is just a way of telling Player.IO that the user can buy X coins for [minor units] in [currency] with UltimatePay.
You specify price points as string in the form of [minor units][currency]=[coins], with multiple price points separated with comma.
For example, the string: "100USD=50,75EUR=50" means that users can buy 50 coins for either 1.00 USD or 0.75 EUR with UltimatePay.
Buying Coins: GetBuyCoinsInfo()
Example of buying coins with PayPal in ActionScript 3:
| Required GetBuyCoinsInfo() Arguments | |
|---|---|
| coinamount | The amount of Coins to purchase. The combination of coinamount and currency must be a defined pricepoint in the PayVault setup. |
| currency | The currency you wish to use for this purchase. The currency must be supported by UltimatePay. |
| amountdesc | The description of the purchase as it will be presented to the user |
| Optional GetBuyDirectInfo() Arguments | |
| accountname | These arguments can be used to customize the UltimatePay experience. See the UltimatePay Parameters section in the UltimatePay Integration Guide for more information. |
| appid | |
| display | |
| xdurl | |
| fname | |
| lname | |
| language | |
| Result Values | |
| sn | These parameters all need to be passed when opening the UltimatePay Lightbox. See the Code Example section in the UltimatePay Integration Guide for more information. |
| userid | |
| currency | |
| amount | |
| amountdesc | |
| merchtrans | |
| hash | |
| accountname | These parameters are present in the result and need to be passed when opening the UltimatePay Lightbox if you specified them in the original method call. |
| appid | |
| xdurl | |
| xdurl | |
| fname | |
| lname | |
| language | |
Buying Items: GetBuyDirectInfo()
Example of buying an item directly with PayPal in ActionScript 3:
| Required GetBuyDirectInfo() Arguments | |
|---|---|
| currency | The currency you wish to use for this purchase. The currency must be supported by UltimatePay. |
| amountdesc | The description of the purchase as it will be presented to the user |
| Optional GetBuyDirectInfo() Arguments | |
| accountname | These arguments can be used to customize the UltimatePay experience. See the UltimatePay Parameters section in the UltimatePay Integration Guide for more information. |
| appid | |
| xdurl | |
| xdurl | |
| fname | |
| lname | |
| language | |
| Result Values | |
| sn | These parameters all need to be passed when opening the UltimatePay Lightbox. See the Code Example section in the UltimatePay Integration Guide for more information. |
| userid | |
| currency | |
| amount | |
| amountdesc | |
| merchtrans | |
| hash | |
| accountname | These parameters are present in the result and need to be passed when opening the UltimatePay Lightbox if you specified them in the original method call. |
| appid | |
| display | |
| xdurl | |
| fname | |
| lname | |
| language | |