API/Autodoc/Classes/RuStoreGodotPayClient.en.md

---

RuStoreGodotPayClient

class_name RuStoreGodotPayClient extends Object

The class implements the API for integrating payments into a mobile application.

Public Member Functions

static	func	get_instance() -> RuStoreGodotPayClient: Get the RuStoreGodotPayClient instance. Returns a pointer to the single RuStoreGodotPayClient instance (Singleton pattern implementation). If the instance has not been created yet, creates it.
	func	get_user_authorization_status(): Check the user authorization status.
	func	get_purchase_availability(): Check payment availability.
	func	is_rustore_installed() -> bool: Check whether RuStore is installed on the user's device. Returns true if RuStore is installed, otherwise — false.
	func	get_products(productIds: Array[RuStorePayProductId]): Get the list of products added to your application via the RuStore console. ◆ productIds — List of product identifiers (set when creating the product in the developer console). The product list is limited to 1000 items.
	func	get_purchases(product_type: Variant = null, purchase_status: Variant = null, acknowledgement_state: Variant = null,): Get the list of user purchases. ◆ product_type — Product type for filtering: ERuStorePayProductType.Item or null (all types). ◆ purchase_status — Purchase status for filtering: ERuStorePayPurchaseStatusFilter.Item or null (all statuses). ◆ acknowledgement_state — Acknowledgement state for filtering: ERuStorePayAcknowledgementState.Item or null (all states).
	func	get_purchase(purchase_id: RuStorePayPurchaseId): Get purchase information. ◆ purchaseId — Product identifier that was assigned to the product in the RuStore console.
	func	purchase(parameters: RuStorePayProductPurchaseParams, preferred_purchase_type: ERuStorePayPreferredPurchaseType.Item = ERuStorePayPreferredPurchaseType.Item.ONE_STEP, sdk_theme: ERuStorePaySdkTheme.Item = ERuStorePaySdkTheme.Item.LIGHT, enable_purchase_event_listener: bool = false,): Purchase a product. ◆ parameters — Product purchase parameters. ◆ preferred_purchase_type — Preferred purchase type. ◆ sdk_theme — Color theme of the payment sheet. ◆ enable_purchase_event_listener — Additional set of callback functions.
	func	purchase_two_step(parameters: RuStorePayProductPurchaseParams, sdk_theme: ERuStorePaySdkTheme.Item = ERuStorePaySdkTheme.Item.LIGHT, enable_purchase_event_listener: bool = false,): Purchase a product with two-step payment. ◆ parameters — Product purchase parameters. ◆ sdk_theme — Color theme of the payment sheet. ◆ enable_purchase_event_listener — Additional set of callback functions.
	func	confirm_two_step_purchase(purchase_id: RuStorePayPurchaseId, developer_payload: RuStorePayDeveloperPayload = null): Consume (acknowledge) a purchase. After calling acknowledgement, the purchase will move to the CONFIRMED status. A purchase consumption (acknowledgement) request must be accompanied by the delivery of the item. ◆ purchase_id — Purchase identifier. ◆ developer_payload — String containing additional order information (optional parameter).
	func	cancel_two_step_purchase(purchase_id: RuStorePayPurchaseId): Cancel a purchase. A purchase consumption (acknowledgement) request must be accompanied by the delivery of the item. ◆ purchase_id — Purchase identifier.
	func	update_acknowledgement_state(purchase_id: RuStorePayPurchaseId, state: ERuStorePayAcknowledgementState.Item, developer_payload: RuStorePayDeveloperPayload = null): Update the purchase acknowledgement state. ◆ purchase_id — Purchase identifier. ◆ state — New purchase acknowledgement state. ◆ developer_payload — String containing additional order information (optional parameter).
	func	get_billing_subscriptions(): Get the list of subscriptions created in the SDK Billing Client.

Signals

	signal	on_get_user_authorization_status_success Action performed on successful completion of the get_user_authorization_status operation.
	signal	on_get_user_authorization_status_failure Action performed in case of an error during the get_user_authorization_status operation.
	signal	on_get_purchase_availability_success Action performed on successful completion of the get_purchase_availability operation.
	signal	on_get_purchase_availability_failure Action performed in case of an error during the get_purchase_availability operation.
	signal	on_get_products_success Action performed on successful completion of the get_products operation.
	signal	on_get_products_failure Action performed in case of an error during the get_products operation.
	signal	on_get_purchases_success Action performed on successful completion of the get_purchases operation.
	signal	on_get_purchases_failure Action performed in case of an error during the get_purchases operation.
	signal	on_get_purchase_success Action performed on successful completion of the get_purchase operation.
	signal	on_get_purchase_failure Action performed in case of an error during the get_purchase operation.
	signal	on_purchase_success Action performed on successful completion of the purchase operation.
	signal	on_purchase_failure Action performed in case of an error during the purchase operation.
	signal	on_purchase_two_step_success Action performed on successful completion of the purchase_two_step operation.
	signal	on_purchase_two_step_failure Action performed in case of an error during the purchase_two_step operation.
	signal	on_confirm_two_step_purchase_success Action performed on successful completion of the confirm_two_step_purchase operation.
	signal	on_confirm_two_step_purchase_failure Action performed in case of an error during the confirm_two_step_purchase operation.
	signal	on_cancel_two_step_purchase_success Action performed on successful completion of the cancel_two_step_purchas operation.
	signal	on_cancel_two_step_purchase_failure Action performed in case of an error during the cancel_two_step_purchas operation.
	signal	on_update_acknowledgement_state_success Action performed on successful completion of the update_acknowledgement_state operation.
	signal	on_update_acknowledgement_state_failure Action performed in case of an error during the update_acknowledgement_state operation.
	signal	on_get_billing_subscriptions_success Action performed on successful completion of the get_billing_subscriptions operation.
	signal	on_get_billing_subscriptions_failure Action performed in case of an error during the get_billing_subscriptions operation.
	signal	on_payment_completed Action performed on successful completion of the payment.
	signal	on_payment_failed Action performed in case of a payment error.
	signal	on_payment_started Action performed at the start of the payment process.
	signal	on_purchase_cancelled Action performed when the user cancels the purchase.
	signal	on_purchase_created Action performed when a purchase is created.