View source for Xanpay

{{NATS4 Manual 
| show_billers_section = true 
}} 

== Setting Up Xanpay ==

Before you can begin setting up Xanpay as a [[Ct#Biller|biller]] in [[NATS]], you must first register for an account with Xanpay. To do so, use the information provided by their website to contact them: https://dashboard.xanpay.com/signup and complete the following steps.

1. Create an account and password.

2. Submit business verification documents [https://dashboard.xanpay.com/kyc here].

3. Collect security keys from [https://dashboard.xanpay.com/api-keys here.

=== Account Verification ===
You will be able to use XanPay to accept payments as soon as your business is verified. If your business documentation is complete and meets the stated requirements, account verification is completed in as little as 2 working days. 

=== Security Keys ===

To collect your security keys from your verified account on XanPay, you will need to take the following steps on the [https://dashboard.xanpay.com/api-keys  API keys page] on the XanPay [https://dashboard.xanpay.com/ dashboard]. 

Click on Create key and select Production key.

Copy the Client ID. Please ensure that the Environment column says Production.

Copy the Secret from the same row. Again, please ensure that the Environment column says Production.

Scroll down to the Certificates section. Click on Create certificate and select Production certificate.

Copy the Public key. Please ensure that the Environment column says Production.

==Billers Admin== 

To add XanPay to NATS, select "Xanpay" from the dropdown menu list of billers next to "Setup New Biller" in the [[NATS5 Billers Management|Billers Admin]]. Once selected, click "Add" on the right side of the page to finish adding Xanpay. 

'''Note''': If you don't see Xanpay, [http://clients.toomuchmedia.com put in a support ticket], as you may need an updated version of [[NATS]]. 

Once you have added the Biller you will be able to edit biller-specific account information by clicking the pencil icon next to Xanpay labeled, "Edit Xanpay Account Info". You will need to get the following information from your Xanpay account:

* Client ID
** Under API Keys tab -> Client

* Secret Key
** Under API Keys tab -> Secret

* Public Key
** Under API Keys tab -> Public Key

* Currency
* Active Number
* Active Period


'''''Note''': Xanpay does not returns the surfer to NATS, Because of this, Xanpay does not support the NATS [[Ct#cascade|cascade]] feature.''<br> 
'''''Note''': Xanpay does not require you to configure a postback URL.''  Postback set by NATS during signup process.

==Sites Admin== 
Xanpay requires no site-specific information to be modified in your tour configuration. Instead, join options with Xanpay must be configured as a special join option by clicking "Set Special Payment Options" next to the site for which you would like to set up a Xanpay join option in the [[NATS4 Sites Admin|Sites Admin]]. 

*'''Xanpay Amount:''' The transaction amount of the join option. 

*'''Xanpay Currency:''' This is the currency that will be used to calculate the transaction amount. 

----  
'''''Note: Xanpay does not postback information regarding the member's expire date so the following fields are required:''''' <br /> 

*'''Xanpay Active Number:''' This is the number of days, hours or minutes you would like to set for the duration of the subscription. 

*'''Xanpay Active Period:''' This is the unit of time for which you would like the Active Number to be active. 



For example, a special join option with Active Number: 1 and Active Period: DAY will be a join option that expires after 1 day.

==Config Admin==
By default, NATS will generate a random username & password for special join options. To allow surfers to set their own username & password, enable the config 'DISPLAY_XANPAY_PREJOIN_PAGE' under the 'Billers' config page.

<!-- [[Category:NATS4 Biller Instructions]] -->

==Additional Setup Information==

If you want like to setup a direct link for Xanpay, you will use the below example:

<nowiki>http://<your_linkdomain>/signup/signup.php?step=special&special[123]=1&nats=XXXXXXX&signup[username]=member_username&signup[email]=member_email&signup[password]=member_password</nowiki>

* replace <your_linkdomain> in the above example with your site link domain
* replace 123 with your join option ID
* replace XXXXXX with your promo NATS code (optional, if not pass then it will become type-in traffic)
* replace member_username with join member username (optional)
* replace member_password with join member password (optional)
* replace member_email with join member email (optional)

In Configuration Admin Biller section, there is a config setting called "DISPLAY_XANPAY_PREJOIN_PAGE", It allows you to enable/disable a join page for COINPAYMENTS during the signup process.