Whether the player uses account verification procedures.
정기 결제 API (2.0)
OpenAPI 설명 다운로드
언어
서버
Mock server
https://xsolla.redocly.app/_mock/ko/api/subscriptions/
요청
임의의 사용자 매개 변수로 토큰을 생성할 수 있습니다. 토큰을 받을 때 이러한 매개 변수를 보내고 성공적인 결제 후에 다시 받습니다. 토큰은 이 문서에 설명되어 있거나 사용자가 미리 정의한 매개 변수만 포함할 수 있습니다.
매개 변수가 잘못된 형식으로 전송되거나 잘못된 유형인 경우 토큰이 발급되지 않습니다. JSON 본문에 오류 설명이 포함된 422 HTTP 코드를 받게 됩니다. extended_message에서 정확히 어떤 매개 변수가 잘못 전송되었는지에 대한 정보를 받게 됩니다.
주의
이 API 호출에는 project_id 경로 매개 변수가 포함되어 있지 않으므로 회사의 모든 프로젝트에서 유효한 API 키를 사용하여 인증을 설정해야 합니다.
보안
basicAuth
custom_parameters 개체의 토큰에서 추가 매개 변수를 전달하여 부정 결제 방지 필터를 구성하세요. 권장 매개 변수는 드롭다운 목록에 표시됩니다. 페이 스테이션 설명서 를 참조하십시오.
구매 데이터 관련 값입니다.
예제: {"checkout":{"amount":10,"currency":"USD"},"subscription":{"gift":{"email":"recipient_email@email.com","recipient":"test_recipient_v1"}}}
Object containing checkout details.
예제: {"amount":10,"currency":"USD"}
정기 결제 데이터 관련 값입니다.
예제: {"gift":{"email":"recipient_email@email.com","recipient":"test_recipient_v1"}}
정기 결제 선물 세부 정보입니다.
예제: {"email":"recipient_email@email.com","recipient":"test_recipient_v1"}
선물한 사람의 이름을 숨길지 여부입니다. true인 경우 이메일 알림에서 발신자 이름이 숨겨집니다. 기본값은 false입니다.
사용자의 정기 결제 요금제에 적용되는 작업 유형입니다. 정기 결제 요금제을 변경하려면 change_plan 값을 전달합니다. purchase.subscription.plan_id 매개 변수에서 새 요금제 ID를 지정해야 합니다.
정기 결제 요금제 외부 ID입니다. 관리자 페이지의 정기 결제 > 정기 결제 요금제 섹션에서 확인할 수 있습니다.
사용자 지정 프로젝트 설정과 관련된 값입니다.
예제: {"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"}}
결제 프로세스를 테스트하기 위한 sandbox 값을 설정합니다. 이 경우 https://sandbox-secure.xsolla.com을 사용하여 테스트 결제 UI에 액세스합니다.
결제 위젯입니다. 'paybycash' 혹은 'giftcard'일 수 있습니다. 매개 변수가 설정되면, 사용자는 각각 페이바이캐쉬(Pay by Cash) 혹은 기프트 카드(Gift Cards) 위젯으로 리디렉션됩니다.
열거형"paybycash""giftcard"
정책 설정을 리디렉션합니다.
페이 스테이션 동작은 닫기 버튼 또는 게임으로 돌아가기 버튼을 사용자가 클릭하면 트리거됩니다. redirect(기본값) 및 postmessage일 수 있습니다. redirect로 설정된 경우 사용자는 토큰에서 전달되었거나 관리자 페이지에서 지정된 URL로 리디렉션됩니다. postmessage로 설정된 경우 사용자는 다른 페이지로 리디렉션되지 않습니다. 닫기 아이콘을 클릭하면 close 이벤트 전송이 시작되고 게임으로 돌아가기 버튼을 클릭하면 return 이벤트 전송이 시작됩니다.
열거형"redirect""postmessage"
사용자가 복귀 URL로 리디렉션되는 결제 상태입니다. 이는 none, successful, successful_or_canсeled, 혹은 any일 수 있습니다.
열거형"none""successful""successful_or_canceled""any"
사용자를 결제 이후로 리디렉션하는 페이지입니다. 매개 변수 user_id, foreigninvoice, invoice_id및 status는 자동으로 링크에 추가됩니다.
인터페이스 설정과 관련된 값입니다.
예제: {"components":{"virtual_currency":{"custom_amount":true}},"desktop":{"virtual_item_list":{"button_with_price":true,"layout":"list"}},"size":"medium"}
메뉴 설정과 관련된 값입니다.
예제: {"virtual_currency":{"custom_amount":true}}
정기 결제 요금제 하위 메뉴 설정과 관련된 값입니다.
인게임 재화 하위 메뉴 설정과 관련된 값입니다.
예제: {"custom_amount":true}
Whether the user can enter an arbitrary quantity of the virtual currency in the payment UI.
예제: true
settings.ui.components.virtual_currency.hiddenboolean
Whether to show the submenu.
가상 아이템 하위 메뉴 설정과 관련된 값입니다.
settings.ui.components.virtual_items.hiddenboolean
Whether to show the submenu.
Group to show after opening the virtual items tab.
PC 버전의 인터페이스 설정과 관련된 값입니다.
예제: {"virtual_item_list":{"button_with_price":true,"layout":"list"}}
헤더 설정과 관련된 값입니다.
페이 스테이션 데스크탑에서 닫기 버튼을 표시할지 여부입니다. 이 버튼을 누르면 페이 스테이션이 종료되고settings.return_url 매개 변수에 지정된 URL로 사용자를 리디렉션합니다(기본값: false).
헤더를 표시하는 설정 방식입니다. compact(프로젝트 이름 및 사용자 ID 표시 안 함) 또는 normal(기본값)을 설정할 수 있습니다.
열거형"compact""normal"
true인 경우, 로고가 헤더에 표시됩니다(먼저 고객 성공 관리자에게 이미지를 제공하세요).
정기 결제 요금제 목록 설정과 관련된 값입니다.
Any text to show above the list of available subscription plans in the payment UI.
true인 경우 및 사용자의 현지 통화가 정기 결제 요금제의 통화와 다른 경우, 사용자는 현지 통화의 가격 및 기본 통화의 가격 등 두 가지 가격을 볼 수 있습니다.
인게임 재화 목록 설정과 관련된 값입니다.
가상 아이템 목록 설정과 관련된 값입니다.
예제: {"button_with_price":true,"layout":"list"}
true인 경우, 가격이 버튼에 표시됩니다. false인 경우, 가격이 버튼 왼쪽에 표시됩니다. 기본값은 false입니다.
예제: true
정기 결제 목록 패턴입니다. list(기본값) 또는 grid일 수 있습니다.
열거형"list""grid"
예제: "list"
외부 리소스에 대한 리디렉션 링크가 비활성화되었는지 여부입니다. true가 기본값입니다. 외부 링크를 클릭하면external-link-open이벤트가 postMessage 메커니즘을 통해 전송됩니다. 리디렉션 링크용 주소는url 매개 변수에서 전달됩니다.
페이 스테이션의 인터페이스 모드입니다. user_account만 가능합니다. 헤더는 계정 탐색 메뉴만 포함하고 사용자는 제품을 선택하거나 결제를 진행할 수 없습니다. 이 모드는 데스크탑에서만 사용할 수 있습니다.
결제 UI의 크기입니다. 이 매개 변수는 결제 UI의 필요한 크기에 따라 값이 다음과 같을 수 있습니다.
열거형"small""medium""large"
예제: "medium"
결제 UI의 모양 테마입니다. default(기본값) 또는 default_dark일 수 있습니다.
열거형"default""default_dark"
사용자 계정 세부 정보입니다.
기록 하위 메뉴입니다.
내 계정 페이지입니다.
내 결제 계정 하위 메뉴입니다.
사용자의 세부 정보입니다.
예제: {"age":19,"country":{"allow_modify":true,"value":"US"},"email":{"value":"john.smith@mail.com"},"id":{"value":"user_2"},"name":{"value":"John Smith"}}
User attributes for filtering the item list, represented as a valid JSON set of key-value pairs.
예제: {"allow_modify":true,"value":"US"}
결제 UI에서 사용자의 국가 변경 가능 여부입니다. country.value가 토큰에서 전달되면 기본값은 false입니다.
예제: true
user.email 개체는 부정 결제 방지 모델 만들기의 정수 부분이며 수락률을 높여줍니다. 해당 개체는 엑솔라와 결제 시스템 양쪽 모두의 요구 사항입니다. 매개 변수가 전달되지 않으면 이메일 입력용 필수 필드가 결제 페이지에 나타납니다. 사용자는 매개 변수에서 전달되었거나 결제 페이지에 입력된 이메일로 구매 영수증을 받습니다.
예제: {"value":"john.smith@mail.com"}
법인 세부 정보가 있는 개체입니다.
기업이 속한 국가입니다. ISO 3166-1 alpha-2에 따른 두 자릿수 대문자 국가 코드입니다.
예제: {"value":"John Smith"}
트래픽 특성입니다.
- https://api.xsolla.com/merchant/v2/merchants/{merchant_id}/token
- Mock serverhttps://xsolla.redocly.app/_mock/ko/api/subscriptions/merchants/{merchant_id}/token
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
-u <username>:<password> \
'https://xsolla.redocly.app/_mock/ko/api/subscriptions/merchants/{merchant_id}/token' \
-H 'Content-Type: application/json' \
-d '{
"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"
}
}
}'응답
application/json
{ "token": "eop57k1boA7nnYPtewZ6KEXJyJADEwRT" }