Key obtaining

Key obtaining for the Cashier opening

Request address

https://a.papaya.ninja/api/authlink/obtain/

shell

curl -G -d 'site_id=1&site_login=test_login&customer_ip=1.2.3.4&currency=USD&signature=51623108afcf1f828e4126d52f16f5d86609b7c3' https://a.papaya.ninja/api/authlink/obtain/

Respond to the key obtaining request:

{
    "key": "ffec614de0db47f697c7ab1142b4478a54e43fce",
    "success": true
}

python

import requests

url = 'https://a.papaya.ninja/api/authlink/obtain/'

params = dict(
    site_id=1,
    site_login='test_login',
    customer_ip='1.2.3.4',
    currency='USD',
    signature='51623108afcf1f828e4126d52f16f5d86609b7c3'
)
resp = requests.get(url=url, params=params)
data = resp.json()

Respond to the key obtaining request:

{
    "key": "ffec614de0db47f697c7ab1142b4478a54e43fce",
    "success": true
}

Main parameters of a key request

Parameter	Mandatory	Format	Description	Example
site_id	Yes	integer	Site identifier in the system	1
site_login	Yes	varchar(256)	User site login	user_test
customer_ip	Yes	inet (ipv4 or ipv6) string	Authorization IP	8.8.8.8
currency	Yes	alpha-3 ISO 4217	Purchase currency	USD
signature	Yes	SHA-1	Request signature, see Request signature generating rules	d9f5713990de5c6e32169dba1f0102f540018975

Key obtaining request additional parameters

Parameter	Mandatory	Format	Description	Example
language	No	ISO 639-1	Cashier language. Supported languages: ru, en, fi, ja, lv, no, sv, uk, zh	en
user_email	Yes	email	User’s e-mail on the site	[email protected]
timezone	No	timezone	User’s timezone	UTC
amount_series	No	string	Amounts in the radio-buttons displayed in the Cashier. The last one is pre-selected amount.	1:10,20,30,40,50,60;
ps_range	No	string	payment_group ranking. Sequence before ”;” for account’s deposit, then for withdrawals, e.g., 2,1,7;5,8,1	12,1,7;5,8,1
deposit_range	No	string	Amounts ranges, displayed to the user.	1:100-1000;2,3,4:200-2000;50-1500
payout_range	No	string	Amounts ranges, displayed to the user.	1:100-1000;2,3,4:200-2000;50-1500
force_action	No	integer	Menu item to display without other tabs	1 - Deposit without tab, 2 - Withdraw without tab, 4 - Deposit with tab 5 - Withdraw with tab
mode	No	string	Cashier interface. Valid values: general, mobile, one_click	general
mirror_url	No	url	Site mirror to open a Cashier	http://example.com
birthdate	Yes	date	User’s birthday	01-01-1980
user_name	Yes	string	User’s First and Last Name	John Doe
first_name	Yes	string	User’s First name	John
last_name	Yes	string	User’s Last name	Doe
user_country	Yes	string(2)	User‘s country ISO-code	UK
user_city	Yes	string	User’s City	London
user_address	Yes	string	User’s address	16 Grand Avenue Street, bldg. 1a
user_postal	Yes	string	User’s postal	121552
user_phone	Yes	string	User’s phone number	[phone]
document_id	No	string	User’s ID number	32000000008
user_preset_id	No	integer	Preset ID number	1
disable_one_click	No	string	one_click Disable	true or false
theme	No	string	The theme/design of the cashier system	theme_1, theme_2, theme_3, theme_4, theme_5, theme_6