토큰 생성

토큰 생성Server-side

post/merchants/{merchant_id}/token

임의의 사용자 매개 변수로 토큰을 생성할 수 있습니다. 토큰을 받을 때 이러한 매개 변수를 보내고 성공적인 결제 후에 다시 받습니다. 토큰은 이 문서에 설명되어 있거나 사용자가 미리 정의한 매개 변수만 포함할 수 있습니다.

매개 변수가 잘못된 형식으로 전송되거나 잘못된 유형인 경우 토큰이 발급되지 않습니다. JSON 본문에 오류 설명이 포함된 422 HTTP 코드를 받게 됩니다. extended_message에서 정확히 어떤 매개 변수가 잘못 전송되었는지에 대한 정보를 받게 됩니다.

주의

이 API 호출에는 project_id 경로 매개 변수가 포함되어 있지 않으므로 회사의 모든 프로젝트에서 유효한 API 키를 사용하여 인증을 설정해야 합니다.

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 구매 통화입니다. ISO 4217에 따른 3자릿수 통화 코드입니다.

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

게임의 엑솔라 ID입니다. 관리자 페이지에서 확인할 수 있습니다.

currency

string

선호하는 결제 통화입니다. ISO 4217에 따른 3자릿수 통화 코드입니다.

external_id

string

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

language

string

인터페이스 언어입니다. 두 자릿수 소문자 언어 코드입니다.

mode

string

결제 프로세스를 테스트하기 위한 sandbox 값을 설정합니다. 이 경우 https://sandbox-secure.xsolla.com을 사용하여 테스트 결제 UI에 액세스합니다.

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` 이벤트 전송이 시작되고 게임으로 돌아가기 버튼을 클릭하면 `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 결제 UI에서 사용 가능한 정기 결제 요금제 목록 위에 표시할 텍스트입니다.
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

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에 따른 두 자릿수 국가 코드입니다.

object

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

value

required

string

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

is_legal

boolean

사용자가 법인인지 여부입니다.

object

법인 세부 정보가 있는 개체입니다. user.is_legal가 true인 경우 개체와 이에 해당하는 모든 매개 변수는 필수입니다.

address	string 법인 전체 주소입니다.
country	string 기업이 속한 국가입니다. ISO 3166-1 alpha-2에 따른 두 자릿수 대문자 국가 코드입니다.
name	string 법인 전체 이름입니다.
vat_id	string 개별 납세자 ID입니다.

object

value

string

사용자 닉네임입니다.

object

value

string

사용자 전화번호입니다.

object

value

string

사용자를 고유하게 식별하고 사용자에게 알려진 매개변수(이메일, 화면 이름 등)입니다. 사용자가 게임 스토어 외부(예: 현금 키오스크)에서 구매할 수 있도록 허용합니다.

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

처리할 수 없는 엔터티입니다.

Request samples

application/json

{"purchase": {"checkout": {"amount": 10,
"currency": "USD"
},
"subscription": {"gift": {"email": "recipient_email@email.com",
"recipient": "test_recipient_v1"
}
}
},
"settings": {"currency": "USD",
"language": "en",
"project_id": 16184,
"ui": {"components": {"virtual_currency": {"custom_amount": true
}
},
"desktop": {"virtual_item_list": {"button_with_price": true,
"layout": "list"
}
},
"size": "medium"
}
},
"user": {"age": 19,
"country": {"allow_modify": true,
"value": "US"
},
"email": {"value": "john.smith@mail.com"
},
"id": {"value": "user_2"
},
"name": {"value": "John Smith"
}
}
}

Response samples

application/json

{"token": "eop57k1boA7nnYPtewZ6KEXJyJADEwRT"
}