Carouseller
Home
  • 🚀Getting started
    • Payment glossary
  • Cashier integration
    • Key obtaining
    • Cashier opening
      • iFrame
      • Native version
    • Cashier opening 2.0
      • iFrame
    • Payment processing
    • Webhooks
      • Successful transaction conditions
      • Notification parameters
    • Report request
    • Tracking user's activity in the cashier
    • User reset conditions
    • Signature
  • Payment API
    • API 1.0
      • Key obtaining
      • Deposit
      • Payout
      • Transaction status
    • API 2.0
      • Payment Page Integration
      • Transaction statuses
    • 3DS handler
  • Transaction types
  • Payment methods
  • Test card numbers
Powered by GitBook
On this page
  • Request address
  • Headers
  • Main parameters of a key request
  • Additional parameters of key request
  • Request example
  1. Payment API
  2. API 1.0

Key obtaining

Obtaining of the session key

Request address

https://carouseller.com/v1/get_session_key/

Headers

{“Content-Type: “application/json”}

Main parameters of a key request

Parameter
Mandatory
Format
Description
Example

site_id

Yes

integer

Client id provided by support with documentation

1

site_login

Yes

varchar(256)

User id

user_test

customer_ip

Yes

inet (ipv4 or ipv6) string

User IP address

8.8.8.8

currency

Yes

alpha-3 ISO 4217

Purchase currency

USD

signature

Yes

SHA-1

d9f5713990de5c6e32169dba1f0102f540018975

Additional parameters of key request

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

No

email

User’s e-mail on the site

test@example.com

timezone

No

timezone

User’s timezone

UTC

force_action

No

integer

Menu item to display without other tabs

1 - Deposit,

2 - Withdraw,

3 - Transaction history

birthdate

No

date

User’s birthday

01-01-1980

user_name

No

string

User’s First and Last Name

John Doe

first_name

No

string

User’s First name

John

last_name

No

string

User’s Last name

Doe

user_country

No

string(2)

User‘s country ISO-code

UK

user_city

No

string

User’s City

London

user_address

No

string

User’s address

16 Grand Avenue Street, bldg. 1a

user_postal

No

string

User’s postal

121552

user_phone

No

string

User’s phone number

+4409874893

document_id

No

string

User’s ID number

32000000008

user_preset_id

No

integer

Preset ID number

1

Request example

{
    "site_id": 24,
    "site_login": "443122443122",
    "customer_ip": "185.56.232.170",
    "currency": "usd",
    "signature": "1234566443"
}
{
    "success": true,
    "session_key": "eyJybmQiOiAiMGQ2OTljNzktODg4YS00MGIyLTkyODQtZjJmNjVmNjI0ZTcwIn0.ZNYWig.-KqQllOh_-5-spvFvz4s8Qka7tM",
    "site_login": "1234567890"
}
{
  "success": false,
    "errors": {
        "currency": ["Length must be 3."]
    }
}
{
    "success": false,
    "errors": {
    "signature": ["Signature is invalid"]
    }
}
PreviousAPI 1.0NextDeposit

Last updated 9 months ago

Request signature,

see Request signature generating rules
Page cover image