Xsolla-logo
  • 문서화
  • 계정 생성

토큰 생성

post/merchants/{merchant_id}/token

You can create a token with arbitrary user parameters. You send these parameters when obtaining the token and receive them back after a successful payment. A token can only contain parameters either described in this document or predefined by you.

If any parameter is sent in the wrong format or has the wrong type, no token will be issued. You will receive a 422 HTTP code with the error description in the JSON body. In extended_message you will receive an information what exact parameters have been sent incorrectly.

Notice

This API call does not contain the project_id path-parameter, so you need to use the API key that is valid in all the company’s projects to set up authorization.

SecuritybasicAuth
Request
path Parameters
merchant_id
required
integer

판매자 ID입니다.

Request Body schema: application/json
object

custom_parameters 개체의 토큰에서 추가 매개 변수를 전달하여 부정 결제 방지 필터를 구성하세요. 권장 매개 변수는 드롭다운 목록에 표시됩니다. 페이 스테이션 설명서 를 참조하세요.

active_date
string

ISO 8601에 따른 마지막 확인 날짜.

additional_verification
boolean

플레이어가 계정 확인 절차를 사용하고 있는지 여부.

character_customized
boolean

플레이어가 자신의 캐릭터를 맞춤 설정했는지 여부.

chat_activity
boolean

플레이어의 채팅 기능 사용 여부.

completed_tasks
integer

완료한 임무/목표의 수.

forum_activity
boolean

플레이어의 포럼 기능 사용 여부.

items_used
boolean

플레이어가 구매한 인게임 아이템을 사용하고 있는지 여부.

karma_points
integer

플레이어의 카르마.

last_change_password_date
string

ISO 8601에 따른 마지막 암호 변경 날짜.

non_premium_currency
integer <float>

프리미엄이 아닌 통화의 금액.

notifications_enabled
boolean

플레이어가 알림을 활성화했는지 여부.

profile_completed
boolean

플레이어가 프로필에 추가 정보를 추가했는지 여부.

profile_image_added
boolean

플레이어가 프로필 이미지를 업로드했는지 여부.

pvp_activity
boolean

플레이어가 PvP 전투에 참여하고 있는지 여부.

registration_date
string

ISO 8601에 따른 계정 생성일.

session_time
string

ISO 8601에 따른 평균 세션 시간.

social_networks_added
boolean

플레이어가 소셜 미디어 프로필을 연결했는지 여부.

total_bans
integer

플레이어가 채팅/포럼에서 금지된 횟수.

total_characters
integer

인게임 캐릭터 수.

total_clans
integer

플레이어가 가입한 클랜의 수.

total_friends
integer

친구의 수.

total_game_events
integer

플레이어가 참여했던 인게임 이벤트의 수.

total_gifts
integer

플레이어가 전송/수신한 인게임 선물의 수.

total_hours
integer

총 인게임 시간.

total_inventory_value
integer <float>

인벤토리의 총 가치(인게임 통화).

total_sum
integer <float>

총 결제 금액.

tutorial_completed
boolean

플레이어가 게임 튜토리얼을 완료했는지 여부.

unlocked_achievements
integer

잠금을 해제한 업적의 수.

user_level
integer

플레이의 레벨, 명성 또는 순위.

win_rate
integer

승률.

object

구매 데이터 관련 값입니다.

object

결제 파라미터 데이터와 관련된 값입니다.

amount
integer <float>

구매 금액입니다.

currency
string

구매 통화입니다. 통화의 3자리 정의가 ISO 4217에 따라 사용됩니다.

object

정기결제 데이터 관련 값입니다.

available_plans
Array of strings

구독권에 대한 데이터가 있는 배열입니다. 오직 이러한 구독권만 결제 UI에 보여집니다.

currency
string

구매 시 플랜의 통화, 이를 바탕으로 모든 계산이 수행됩니다.

object

정기 결제 선물 세부 정보.

recipient
required
string

수신자의 ID.

email
required
string

수신자 이메일.

anonymous
boolean

선물한 사람의 이름을 숨길지 여부. true로 설정하면 이메일 알림에서 발신자 이름이 숨겨집니다. 기본값은 false입니다.

message
string

수신자에게 표시되는 메시지입니다.

redirect_url
string

정기 결제 선물에 대한 추가 정보가 있는 페이지 또는 계정 생성 페이지로 연결되는 링크를 여기에 입력합니다. 선물 받는 사람은 정기 결제 선물 이메일 알림에서 이 페이지로 이동할 수 있습니다.

operation
string

사용자의 구독 플랜에 적용되는 작업 유형. 구독 플랜을 변경하려면 change_plan 값을 전달합니다. purchase.subscription.plan_id 매개변수에서 새 플랜 ID를 지정해야 합니다.

plan_id
string

정기 결제 플랜 외부 ID. 관리자 페이지의 정기 결제 > 정기 결제 플랜 섹션에서 확인할 수 있습니다.

product_id
string

제품 ID.

trial_days
integer

평가 기간(일)입니다.

object

사용자 지정 프로젝트 설정와 관련된 객체입니다.

project_id
required
integer

엑솔라 시스템 내의 게임 식별자입니다. 판매자 계정 에서 확인할 수 있습니다.

currency
string

선호하는 결제 통화입니다. 통화의 3자리 정의가 ISO 4217에 따라 사용됩니다.

external_id
string

게임의 트랜잭션 ID 입니다. 각 사용자 결제별로 고유해야 합니다.

language
string

인터페이스 언어입니다. 2자리 소문자 언어 코드입니다.

mode
string

결제 프로세스를 테스트하기 위한 sandbox 값을 설정합니다. 참고로 결제 UI의 URL은 https://sandbox-secure.xsolla.com 이 됩니다.

payment_method
integer

결제 수단의 ID입니다.

payment_widget
string

결제 위젯. '페이바이캐쉬(paybycash)' 혹은 '기프트카드(giftcard)'일 수 있습니다. 한도가 설정되면, 사용자는 각각 페이바이캐쉬(Pay by Cash) 혹은 기프트 카드(Gift Cards) 위젯으로 다시 보내집니다.

Enum: "paybycash" "giftcard"
object

재지정 정책 설정(객체).

autoredirect_from_status_page
boolean

상태 페이지에서 자동 리디렉션 여부.

delay
integer

사용자가 복귀 URL로 자동 재지정된 이후 지연 시간(초).

manual_redirection_action
string

페이 스테이션 동작은 닫기 버튼 또는 게임으로 돌아가기 버튼을 사용자가 클릭하면 트리거됩니다. redirect(기본값) 및 postmessage가 될 수 있습니다. redirect로 설정되었다면 사용자는 토큰에서 전달되었거나 관리자 페이지에서 지정된 URL로 리디렉션 됩니다. postmessage로 설정되었다면 사용자는 다른 페이지로 리디렉션되지 않습니다. 닫기 아이콘 버튼을 클릭하면 close 이벤트 보내기 및 clicking the 게임으로 돌아가기 버튼 클릭(return 이벤트)이 초기화됩니다.

Enum: "redirect" "postmessage"
redirect_button_caption
string

수동 재지정 버튼 문구.

redirect_conditions
string

복귀 URL로 사용자 재지정 시 지불 상태. 이는 none, successful, successful_or_canсeled, 혹은 any일 수 있습니다.

Enum: "none" "successful" "successful_or_canceled" "any"
status_for_manual_redirection
string

복귀 URL로 사용자 재지정 버튼 지불 상태. 이는 none, successful, successful_or_canсeled, 혹은 any일 수 있습니다.

Enum: "none" "successful" "successful_or_canceled" "any"
return_url
string

사용자는 결제 후 이 페이지로 리디렉트됩니다. 파라미터 user_id, foreigninvoice, invoice_id(와)과 status(은)는 자동으로 링크에 추가됩니다.

object

인터페이스 설정 데이터와 관련된 값입니다.

object

모듈 메뉴 설정 데이터와 관련된 값입니다.

object

정기 결제 모듈 설정 데이터와 관련된 값입니다.

hidden
boolean

모듈 메뉴에 게임 아이템을 표시하는지 여부를 나타냅니다.

order
integer

모듈 메뉴에서 게임 아이템의 위치입니다.

object

게임머니 모듈 설정 데이터와 관련된 값입니다.

custom_amount
boolean

사용자가 결제 UI에 임의의 가상 통화 수량을 입력할 수 있도록 설정합니다.

hidden
boolean

모듈 메뉴에 게임 아이템을 표시하는지 여부를 나타냅니다.

order
integer

모듈 메뉴에서 게임 아이템의 위치입니다.

object

게임 아이템 모듈 설정 데이터와 관련된 값입니다.

hidden
boolean

모듈 메뉴에 게임 아이템을 표시하는지 여부를 나타냅니다.

order
integer

모듈 메뉴에서 게임 아이템의 위치입니다.

selected_group
string

게임유저가 게임 아이템 탭을 열었을 때 선택되는 그룹입니다.

selected_item
string

게임유저가 게임 아이템 탭을 열었을 때 선택되는 아이템입니다. 아이템 SKU는 이곳에서 보내야 합니다.

object

PC 버전의 인터페이스 설정 데이터와 관련된 값입니다.

object

헤더 설정 데이터와 관련된 값입니다.

close_button
boolean

페이 스테이션 데스크탑에서 닫기 버튼을 표시할지 여부. 이 버튼을 누르면 페이 스테이션이 종료되고settings.return_url 매개변수에 지정된 URL로 사용자를 리디렉션합니다(기본값: false).

is_visible
boolean

결제 UI에 헤더가 표시되는지 여부를 나타냅니다.

type
string

헤더를 표시하는 설정 방식입니다. compact(프로젝트 이름 및 사용자 ID 표지 안 함) 또는 normal (기본값)을 설정할 수 있습니다.

Enum: "compact" "normal"
visible_logo
boolean

true일 경우, 로고가 헤더에 표시됩니다(먼저 고객 성공 관리자에게 이미지를 제공하세요).

visible_name
boolean

프로젝트 이름이 헤더에 표시되는지 여부를 나타냅니다.

visible_purchase
boolean

구매 설명(purchase.description.value)이 헤더에 표시되는지 여부를 나타냅니다. 기본값은 true입니다.

object

정기 결제 목록 설정 데이터와 관련된 값입니다.

description
string

정기결제에 관한 어떠한 텍스트도 이곳에서 전달할 수 있습니다. 정기 결제 요금제 목록 위에 텍스트가 표시됩니다.

display_local_price
boolean

true인 경우 및 사용자의 현지 통화가 정기결제 플랜의 통화와 다른 경우, 사용자는 현지 통화의 가격 및 기본 통화의 가격과 같이 두 가지 가격을 볼 수 있습니다.

layout
string

정기 결제 목록 패턴입니다. list (기본값) 또는 grid가 가능합니다.

Enum: "list" "grid"
object

게임머니 목록 설정 데이터와 관련된 값입니다.

button_with_price
boolean

true인 경우, 가격이 버튼에 표시됩니다. false인 경우, 가격이 버튼 왼쪽에 표시됩니다. 기본적으로 false입니다.

description
string

게임머니 목록에 관한 어떠한 텍스트도 이곳에서 전달할 수 있습니다. 게임머니 패키지 목록 위에 텍스트가 표시됩니다.

object

게임 아이템 목록 설정 데이터와 관련된 값입니다.

button_with_price
boolean

true인 경우, 가격이 버튼에 표시됩니다. false인 경우, 가격이 버튼 왼쪽에 표시됩니다. 기본적으로 false입니다.

layout
string

정기 결제 목록 패턴입니다. list (기본값) 또는 grid가 가능합니다.

Enum: "list" "grid"
view
string

가상 아이템 그룹을 수직/수평 메뉴로 표시합니다. horizontal_navigation 또는 vertical_navigation(기본)이 가능합니다.

Enum: "horizontal_navigation" "vertical_navigation"
object
visible_virtual_currency_balance
boolean

결제 UI에서 이 요소를 숨길 수 있는지 여부를 나타냅니다. 기본값은 true입니다.

is_prevent_external_link_open
boolean

외부 리소스로 링크 리디렉션 여부가 비활성화되었습니다.true가 기본값입니다. 외부 링크를 클릭하면external-link-open이벤트가postMessage메커니즘을 통해 전송됩니다. 리디렉션 링크용 주소는url매개 변수에서 전달됩니다.

license_url
string

EULA의 링크입니다.

object
object
is_visible
boolean

모바일 버전의 결제 UI에서 바닥글을 표시하거나 숨길지 여부입니다.

object
close_button
boolean

페이 스테이션 모바일에서 닫기 버튼을 표시할지 여부. 이 버튼을 누르면 페이 스테이션이 종료되고settings.return_url 매개변수에 지정된 URL로 사용자를 리디렉션합니다(기본값: false).

mode
string

사용자는 저장된 결제 방법을 통해서만 결제를 할 수 있습니다. saved_accounts일 수 있습니다.

Value: "saved_accounts"
mode
string

사용자 계정의 결제 인터페이스입니다. 가능한 값은 user_account입니다. 헤더에는 제품을 선택하거나 결제를 하기 위한 옵션 없이 사용자 계정의 탐색 메뉴만 포함되어 있고, 사용자 계정은 데스크톱 모드에서만 사용 가능합니다.

size
string

결제 UI의 크기입니다. 이 매개 변수는 결제 UI의 필요한 크기에 따라 값이 다음과 같을 수 있습니다.

  • small: 결제 UI의 가능한 최소 크기입니다. 창 크기가 엄격히 제한되는 경우 이 값을 사용합니다. (크기: 620 x 630)
  • medium: 결제 UI의 권장 크기입니다. 이 값을 사용하여 라이트박스에 결제 UI를 표시합니다. (크기: 740 x 760)
  • large: 새 창 또는 탭에 결제 UI 표시를 위한 최적의 크기입니다. (크기: 820 x 840)
Enum: "small" "medium" "large"
theme
string

결제 UI의 모양 테마입니다. default (기본값) 또는 default_dark가 가능합니다.

Enum: "default" "default_dark"
object

사용자 계정에 관한 데이터가 담긴 객체.

object

사용자의 기록 페이지입니다.

enable
boolean

모듈 메뉴에 게임 아이템을 표시하는지 여부를 나타냅니다. 기본값은 false입니다.

order
integer

모듈 메뉴에서 게임 아이템의 위치입니다.

object

내 계정 페이지입니다.

enable
boolean

모듈 메뉴에 게임 아이템을 표시하는지 여부를 나타냅니다. 기본값은 false입니다.

order
integer

모듈 메뉴에서 게임 아이템의 위치입니다.

object

저장된 결제수단 페이지입니다.

enable
boolean

모듈 메뉴에 게임 아이템을 표시하는지 여부를 나타냅니다. 기본값은 false입니다.

order
integer

모듈 메뉴에서 게임 아이템의 위치입니다.

object

정기결제 관리 페이지입니다.

enable
boolean

모듈 메뉴에 게임 아이템을 표시하는지 여부를 나타냅니다. 기본값은 false입니다.

order
integer

모듈 메뉴에서 게임 아이템의 위치입니다.

version
string

장치 유형입니다. desktop (기본값) 또는 mobile이 가능합니다.

Enum: "desktop" "mobile"
object

사용자에 대한 데이터가 포함된 개체입니다.

required
object
value
required
string

사용자 ID.

age
integer

사용자 나이.

attributes
object

게임유저 특성 데이터와 관련된 객체로서 아이템 목록을 필터링하는데 사용됩니다. 키값 쌍을 가진 올바른 JSON 해시여야 합니다.

object
allow_modify
boolean

결제 UI에서 사용자의 국가 변경 가능 여부. country.value가 토큰에서 전달되면 기본값은 false입니다.

value
string

ISO 3166-1 alpha-2 standard에 따른 2자로 된 국가 코드를 사용합니다.

object

user.email 개체는 부정 결제 방지 모델 만들기의 정수 부분이며 수락률을 높여줍니다. 해당 개체는 엑솔라와 결제 시스템 양쪽 모두의 요구 사항입니다. 매개 변수가 전달되지 않으면 이메일 입력용 필수 필드가 결제 페이지에 나타납니다. 사용자는 매개 변수에서 전달되었거나 결제 페이지에 입력된 이메일로 구매 영수증을 받습니다.

value
required
string

사용자 이메일. RFC 822 프로토콜에 따라 유효해야 합니다.

is_legal
boolean

게임유저가 법인인지 여부를 나타냅니다.

object

법인 세부 정보가 있는 오브젝트. user.is_legaltrue인 경우 오브젝트와 이에 해당하는 모든 매개변수는 필수입니다.

address
string

법인 전체 주소.

country
string

기업이 속한 국가. ISO 3166-1 alpha-2 standard에 따른 2자로 된 대문자 국가 코드를 사용합니다.

name
string

법인 전체 이름.

vat_id
string

개별 납세자 식별자.

object
value
string

게임유저 닉네임입니다.

object
value
string

전화번호.

object
value
string

사용자를 고유하게 식별할 수 있고 사용자 ID(이메일, 애칭 등)와 달리 사용자에 대해 알려진 매개 변수입니다. 이 매개 변수는 게임 스토어 외부(예: 캐시 키오스크의 게임 버튼)에서 구매할 수 있을 때 사용됩니다.

object
value
string

Steam ID입니다.

object
value
string

고유한 추적 ID(마케팅 캠페인에 사용됨)입니다.

object

트래픽 성향을 나타내는 데이터를 포함한 오브젝트.

utm_campaign
string

캠페인 제목. 이 항목은 음차한 캠페인 제목이나 영어로 번역한 캠페인 제목을 포함해야 합니다.

utm_content
string

캠페인 구성 요소.

utm_medium
string

트래픽 채널(맥락 이해 광고, 언론 광고, 이메일 목록 메시지).

utm_source
string

트래픽 소스.

utm_term
string

캠페인 키워드. 이 항목을 지정할 경우 광고 캠페인 목표 설정에 사용된 키워드 데이터에 기반하여 통계가 만들어집니다. Google Analytics에서는 utm_term 라벨 콘텐츠가 검색어를 포함한 일반 보고서의 일부가 됩니다.

Responses
200

생성됨.

422

Unprocessable Entity.

Request samples
application/json
{
  • "purchase": {
    },
  • "settings": {
    },
  • "user": {
    }
}
Response samples
application/json
{
  • "token": "eop57k1boA7nnYPtewZ6KEXJyJADEwRT"
}