Page cover

Key obtaining

Key obtaining for the Cashier opening

Request address

https://a.papaya.ninja/api/authlink/obtain/
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
}

Main parameters of a key request

Parameter
Required
Type
Format
Description
Example

site_id

Yes

integer

–

Site identifier in the system

1

site_login

Yes

string

varchar(256)

User site login

user_test

customer_ip

Yes

string

inet (ipv4 or ipv6) string

Authorization IP

8.8.8.8

currency

Yes

string

alpha-3 ISO 4217

Purchase currency

USD

signature

Yes

string

SHA-1

d9f5713990de5c6e32169dba1f0102f540018975

Key obtaining request additional parameters

Parameter
Required
Type
Format
Description
Example

language

No

string

ISO 639-1

Cashier language. Supported languages: ru, en, fi, ja, lv, no, sv, uk, zh

en

user_email

Yes

string

email

User’s e-mail on the site

timezone

No

string

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

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

–

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 (values)

1

mode

No

string

enum

Cashier interface. Valid values: general, mobile, one_click

general

mirror_url

No

string

url

Site mirror to open a Cashier

http://example.com

birthdate

Yes

string

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

ISO 3166-1 alpha-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

+4409874893

document_id

No

string

–

User’s ID number

32000000008

user_preset_id

No

integer

–

Preset ID number

1

disable_one_click

No

boolean

–

one_click Disable

true or false

theme

No

string

enum

The theme/design of the cashier system

theme_1, theme_2, theme_3, theme_4, theme_5, theme_6, dark

read_only

No

boolean

–

User has read-only access

true

sc_blind

No

integer

–

Preselection amount deposit for projects with virtual currency

100

force_min_deposit_amount

No

integer

–

Field for minimum deposit amount

10

is_manual_admin_session

No

boolean

–

false

has_metamask

No

boolean

–

Use of MetaMask

true

is_multicurrency

No

boolean

–

Use of multi-currencies

true

ps_in_commissions

No

string

–

Payment system commissions for deposits

1:0.05,2:0.03

ps_out_commissions

No

string

–

Payment system commissions for payouts

1:0.05,2:0.03

preselection_amount

No

integer

–

Selected initial amount

50

user_verified

No

boolean

–

Whether user is verified

true

trustly_uuid

No

string

UUID

UUID for Trustly

550e8400-e29b-41d4-a716-446655440000

trumo_uuid

No

string

UUID

UUID for Trumo

550e8400-e29b-41d4-a716-446655440000

antiscam

No

boolean

–

Use antiscam settings

true

reg_date

No

string

date

Registration date

2024-01-15

platform_type

No

integer

enum

Device type from which user logged in (values)

2

telegram_user_id

No

string

–

Unique user identifier in Telegram

123456789

currency_iso_disabled

No

boolean

–

Disable currency display in ISO format (for legacy cashier)

false

Last updated