Create project

post/merchants/{merchant_id}/projects

Creates a new project.

SecuritybasicAuth

Request

path Parameters

merchant_id

required

integer

Merchant ID.

Request Body schema: application/json

payment_url

string

Webhook URL.

key

string

Project secret key.

return_url

string

URL to redirect a user to after a successful payment. For mobile apps, it might be а URL or a path within the app itself (e.g.: app://home).

user_billing_enabled

boolean

Whether to keep user data in the Xsolla database.

show_user_in_paystation

boolean

Whether to show the user's saved payment accounts and payment history in the payment UI.

user_public_id_enabled

boolean

Enables user details verification via Public User ID (for payments through cash kiosks).

is_external_id_required

boolean

Whether External ID is required for integration with Xsolla.

ipn_enabled

boolean

If true, Xsolla will send an HTTP payload to the webhook's configured URL when certain events occur. The webhook URL is set in the payment_url parameter.

is_universal_item_enabled

boolean

Whether to have an account type that allows to use the Xsolla SDKs.

send_email_for_user_billing_purchase

boolean

Whether to send email notifications to user for balance transactions.

autoredirect_from_status_page

string

A payment status for automatic redirect.

Enum:	Description
none	No redirect.
done	Redirect when a payment is successful.
final	Redirect when a payment is successful or canceled.
all	Redirect for any payment status.

autoredirect_from_status_page_in_seconds

integer

Time (in seconds) before autoredirect.

status_page_show_return_to_game_link

string

A payment status for manual redirect.

Enum:	Description
none	No redirect.
done	Redirect when a payment is successful.
final	Redirect when a payment is successful or canceled.
all	Redirect for any payment status.

object

Localized redirect button captions.

en	string English.
ru	string Russian.
cs	string Czech.
ar	string Arabic.
bg	string Bulgarian.
cn	string Chinese (Simplified).
tw	string Chinese (Traditional).
fr	string French.
de	string German.
he	string Hebrew.
it	string Italian.
ja	string Japanese.
ko	string Korean.
pl	string Polish.
pt	string Portuguese.
ro	string Romanian.
es	string Spanish.
th	string Thai.
tr	string Turkish.
vi	string Vietnamese.

descriptor

string

Short project name for reports (up to 12 characters).

locale_list

Array of strings

List of languages that corresponding settings are localized to.

object

Localized project names.

en	string English.
ru	string Russian.
cs	string Czech.
ar	string Arabic.
bg	string Bulgarian.
cn	string Chinese (Simplified).
tw	string Chinese (Traditional).
fr	string French.
de	string German.
he	string Hebrew.
it	string Italian.
ja	string Japanese.
ko	string Korean.
pl	string Polish.
pt	string Portuguese.
ro	string Romanian.
es	string Spanish.
th	string Thai.
tr	string Turkish.
vi	string Vietnamese.

url

string

Project website URL.

description

string

Array of localized project descriptions.

object

Project modules.

object

Module details.

object

Localized module names to show in the payment UI.

en	string English.
ru	string Russian.
cs	string Czech.
ar	string Arabic.
bg	string Bulgarian.
cn	string Chinese (Simplified).
tw	string Chinese (Traditional).
fr	string French.
de	string German.
he	string Hebrew.
it	string Italian.
ja	string Japanese.
ko	string Korean.
pl	string Polish.
pt	string Portuguese.
ro	string Romanian.
es	string Spanish.
th	string Thai.
tr	string Turkish.
vi	string Vietnamese.

enabled

boolean

Whether to enable the module for this project.

name

string

Module name in English.

object

Module details.

object

Localized module names to show in the payment UI.

en	string English.
ru	string Russian.
cs	string Czech.
ar	string Arabic.
bg	string Bulgarian.
cn	string Chinese (Simplified).
tw	string Chinese (Traditional).
fr	string French.
de	string German.
he	string Hebrew.
it	string Italian.
ja	string Japanese.
ko	string Korean.
pl	string Polish.
pt	string Portuguese.
ro	string Romanian.
es	string Spanish.
th	string Thai.
tr	string Turkish.
vi	string Vietnamese.

enabled

boolean

Whether to enable the module for this project.

name

string

Module name in English.

object

Module details.

object

Localized module names to show in the payment UI.

en	string English.
ru	string Russian.
cs	string Czech.
ar	string Arabic.
bg	string Bulgarian.
cn	string Chinese (Simplified).
tw	string Chinese (Traditional).
fr	string French.
de	string German.
he	string Hebrew.
it	string Italian.
ja	string Japanese.
ko	string Korean.
pl	string Polish.
pt	string Portuguese.
ro	string Romanian.
es	string Spanish.
th	string Thai.
tr	string Turkish.
vi	string Vietnamese.

enabled

boolean

Whether to enable the module for this project.

name

string

Module name in English.

object

Module details.

object

Localized module names to show in the payment UI.

en	string English.
ru	string Russian.
cs	string Czech.
ar	string Arabic.
bg	string Bulgarian.
cn	string Chinese (Simplified).
tw	string Chinese (Traditional).
fr	string French.
de	string German.
he	string Hebrew.
it	string Italian.
ja	string Japanese.
ko	string Korean.
pl	string Polish.
pt	string Portuguese.
ro	string Romanian.
es	string Spanish.
th	string Thai.
tr	string Turkish.
vi	string Vietnamese.

enabled

boolean

Whether to enable the module for this project.

name

string

Module name in English.

object

Module details.

object

Localized module names to show in the payment UI.

en	string English.
ru	string Russian.
cs	string Czech.
ar	string Arabic.
bg	string Bulgarian.
cn	string Chinese (Simplified).
tw	string Chinese (Traditional).
fr	string French.
de	string German.
he	string Hebrew.
it	string Italian.
ja	string Japanese.
ko	string Korean.
pl	string Polish.
pt	string Portuguese.
ro	string Romanian.
es	string Spanish.
th	string Thai.
tr	string Turkish.
vi	string Vietnamese.

enabled

boolean

Whether to enable the module for this project.

name

string

Module name in English.

object

Module details.

object

Localized module names to show in the payment UI.

en	string English.
ru	string Russian.
cs	string Czech.
ar	string Arabic.
bg	string Bulgarian.
cn	string Chinese (Simplified).
tw	string Chinese (Traditional).
fr	string French.
de	string German.
he	string Hebrew.
it	string Italian.
ja	string Japanese.
ko	string Korean.
pl	string Polish.
pt	string Portuguese.
ro	string Romanian.
es	string Spanish.
th	string Thai.
tr	string Turkish.
vi	string Vietnamese.

enabled

boolean

Whether to enable the module for this project.

name

string

Module name in English.

object

Module details.

object

Localized module names to show in the payment UI.

en	string English.
ru	string Russian.
cs	string Czech.
ar	string Arabic.
bg	string Bulgarian.
cn	string Chinese (Simplified).
tw	string Chinese (Traditional).
fr	string French.
de	string German.
he	string Hebrew.
it	string Italian.
ja	string Japanese.
ko	string Korean.
pl	string Polish.
pt	string Portuguese.
ro	string Romanian.
es	string Spanish.
th	string Thai.
tr	string Turkish.
vi	string Vietnamese.

enabled

boolean

Whether to enable the module for this project.

name

string

Module name in English.

img

string

xsolla_tips_enabled

string

Enum: "none" "xsolla" "project"

Array of objects

Array

currency

required

string

country

required

string

required

Array of objects

Array

min

required

number

max

number

Array of objects

Array

value required	number
active required	boolean

Array of objects

Array

value required	number
active required	boolean

integration_type

string

Project integration type.

Enum: "standard" "tokenless" "simplified" "play_fab"

Responses

201

Created.

404

Not Found.

Request samples

application/json

{"payment_url": "string",
"key": "string",
"return_url": "string",
"user_billing_enabled": true,
"show_user_in_paystation": true,
"user_public_id_enabled": true,
"is_external_id_required": true,
"ipn_enabled": true,
"is_universal_item_enabled": true,
"send_email_for_user_billing_purchase": true,
"autoredirect_from_status_page": "none",
"autoredirect_from_status_page_in_seconds": 0,
"status_page_show_return_to_game_link": "none",
"status_page_return_to_game_link_name": {"en": "string",
"ru": "string",
"cs": "string",
"ar": "string",
"bg": "string",
"cn": "string",
"tw": "string",
"fr": "string",
"de": "string",
"he": "string",
"it": "string",
"ja": "string",
"ko": "string",
"pl": "string",
"pt": "string",
"ro": "string",
"es": "string",
"th": "string",
"tr": "string",
"vi": "string"
},
"descriptor": "string",
"locale_list": ["string"
],
"name": {"en": "string",
"ru": "string",
"cs": "string",
"ar": "string",
"bg": "string",
"cn": "string",
"tw": "string",
"fr": "string",
"de": "string",
"he": "string",
"it": "string",
"ja": "string",
"ko": "string",
"pl": "string",
"pt": "string",
"ro": "string",
"es": "string",
"th": "string",
"tr": "string",
"vi": "string"
},
"url": "string",
"description": "string",
"components": {"virtual_currency": {"custom_name": {"en": "string",
"ru": "string",
"cs": "string",
"ar": "string",
"bg": "string",
"cn": "string",
"tw": "string",
"fr": "string",
"de": "string",
"he": "string",
"it": "string",
"ja": "string",
"ko": "string",
"pl": "string",
"pt": "string",
"ro": "string",
"es": "string",
"th": "string",
"tr": "string",
"vi": "string"
},
"enabled": true,
"name": "string"
},
"items": {"custom_name": {"en": "string",
"ru": "string",
"cs": "string",
"ar": "string",
"bg": "string",
"cn": "string",
"tw": "string",
"fr": "string",
"de": "string",
"he": "string",
"it": "string",
"ja": "string",
"ko": "string",
"pl": "string",
"pt": "string",
"ro": "string",
"es": "string",
"th": "string",
"tr": "string",
"vi": "string"
},
"enabled": true,
"name": "string"
},
"simple_checkout": {"custom_name": {"en": "string",
"ru": "string",
"cs": "string",
"ar": "string",
"bg": "string",
"cn": "string",
"tw": "string",
"fr": "string",
"de": "string",
"he": "string",
"it": "string",
"ja": "string",
"ko": "string",
"pl": "string",
"pt": "string",
"ro": "string",
"es": "string",
"th": "string",
"tr": "string",
"vi": "string"
},
"enabled": true,
"name": "string"
},
"subscriptions": {"custom_name": {"en": "string",
"ru": "string",
"cs": "string",
"ar": "string",
"bg": "string",
"cn": "string",
"tw": "string",
"fr": "string",
"de": "string",
"he": "string",
"it": "string",
"ja": "string",
"ko": "string",
"pl": "string",
"pt": "string",
"ro": "string",
"es": "string",
"th": "string",
"tr": "string",
"vi": "string"
},
"enabled": true,
"name": "string"
},
"coupons": {"custom_name": {"en": "string",
"ru": "string",
"cs": "string",
"ar": "string",
"bg": "string",
"cn": "string",
"tw": "string",
"fr": "string",
"de": "string",
"he": "string",
"it": "string",
"ja": "string",
"ko": "string",
"pl": "string",
"pt": "string",
"ro": "string",
"es": "string",
"th": "string",
"tr": "string",
"vi": "string"
},
"enabled": true,
"name": "string"
},
"game_delivery": {"custom_name": {"en": "string",
"ru": "string",
"cs": "string",
"ar": "string",
"bg": "string",
"cn": "string",
"tw": "string",
"fr": "string",
"de": "string",
"he": "string",
"it": "string",
"ja": "string",
"ko": "string",
"pl": "string",
"pt": "string",
"ro": "string",
"es": "string",
"th": "string",
"tr": "string",
"vi": "string"
},
"enabled": true,
"name": "string"
},
"physical_goods": {"custom_name": {"en": "string",
"ru": "string",
"cs": "string",
"ar": "string",
"bg": "string",
"cn": "string",
"tw": "string",
"fr": "string",
"de": "string",
"he": "string",
"it": "string",
"ja": "string",
"ko": "string",
"pl": "string",
"pt": "string",
"ro": "string",
"es": "string",
"th": "string",
"tr": "string",
"vi": "string"
},
"enabled": true,
"name": "string"
}
},
"img": "string",
"xsolla_tips_enabled": "none",
"xsolla_tips_settings": [{"currency": "string",
"country": "string",
"values": [{"min": 0,
"max": 0,
"values": [{"value": 0,
"active": true
}
],
"percent": [{"value": 0,
"active": true
}
]
}
]
}
],
"integration_type": "standard"
}