API/Autodoc/Classes/RuStore.PayClient.ProductPurchase.en.md

---

RuStore::PayClient::ProductPurchase

Purchase information.

Inherits from RuStore.PayClient.BaseFields, RuStore.PayClient.IPurchaseStatus< ProductPurchaseStatus >, RuStore.PayClient.IPurchase

Public Functions

Name

ProductPurchase(AmountLabel amountLabel, Currency currency, Description description, DeveloperPayload? developerPayload, InvoiceId invoiceId, OrderId? orderId, Price price, ProductId productId, ProductType productType, PurchaseId purchaseId, DateTime? purchaseTime, PurchaseType purchaseType, Quantity quantity, ProductPurchaseStatus status, bool sandbox, AcknowledgementState acknowledgementState) Constructor.

Public Properties

	Name
AmountLabel	amountLabel — Formatted purchase price, including currency symbol.
Currency	currency — ISO 4217 currency code.
Description	description — Description in the language specified by language.
DeveloperPayload?	developerPayload — String with additional order information that you can set when initializing the purchase process (optional parameter).
InvoiceId	invoiceId — Invoice identifier.
OrderId?	orderId — Unique payment identifier generated by the application (optional parameter). If you specify this parameter in your system, you will receive it in the response when working with the API. If you do not specify it, it will be generated automatically (uuid). Maximum length 150 characters.
Price	price — Price in minimum units (for example, in kopecks).
ProductId	productId — Product identifier that was assigned to the product in the RuStore console.
PurchaseId	purchaseId — Purchase identifier.
DateTime?	purchaseTime — Purchase time (optional parameter).
Quantity	quantity — Product quantity.
bool	sandbox — Determines whether the payment is test. Values can be true or false, where true denotes a test payment and false denotes a real payment.

Additional inherited members

Public Functions inherited from RuStore.PayClient.BaseFields

	Name
override bool	Equals(object obj)
override int	GetHashCode()
override string	ToString()

function ProductPurchase

ProductPurchase(
    AmountLabel amountLabel,
    Currency currency,
    Description description,
    DeveloperPayload? developerPayload,
    InvoiceId invoiceId,
    OrderId? orderId,
    Price price,
    ProductId productId,
    ProductType productType,
    PurchaseId purchaseId,
    DateTime? purchaseTime,
    PurchaseType purchaseType,
    Quantity quantity,
    ProductPurchaseStatus status,
    bool sandbox,
    AcknowledgementState acknowledgementState
)

Constructor.

Parameters:

• amountLabel Formatted purchase price, including currency symbol.
• currency ISO 4217 currency code.
• description Description in the language specified by language.
• developerPayload String with additional order information that you can set when initializing the purchase process (optional parameter).
• invoiceId Invoice identifier.
• orderId Unique payment identifier generated by the application (optional parameter). If you specify this parameter in your system, you will receive it in the response when working with the API. If you do not specify it, it will be generated automatically (uuid). Maximum length 150 characters.
• price Price in minimum units (for example, in kopecks).
• productType Product type.
• purchaseId Purchase identifier.
• purchaseTime Purchase time (optional parameter).
• purchaseType Purchase type.
• quantity Product quantity.
• status Purchase status.
• sandbox Determines whether the payment is test. Values can be true or false, where true denotes a test payment and false denotes a real payment.
• acknowledgementState Purchase acknowledgment state.

property amountLabel

AmountLabel amountLabel;

Formatted purchase price, including currency symbol.

property currency

Currency currency;

ISO 4217 currency code.

property description

Description description;

Description in the language specified by language.

property developerPayload

DeveloperPayload? developerPayload;

String with additional order information that you can set when initializing the purchase process (optional parameter).

property invoiceId

InvoiceId invoiceId;

Invoice identifier.

property orderId

OrderId? orderId;

Unique payment identifier generated by the application (optional parameter). If you specify this parameter in your system, you will receive it in the response when working with the API. If you do not specify it, it will be generated automatically (uuid). Maximum length 150 characters.

property price

Price price;

Price in minimum units (for example, in kopecks).

property productId

ProductId productId;

Product identifier that was assigned to the product in the RuStore console.

property productType

ProductType productType;

Product type.

property purchaseId

PurchaseId purchaseId;

Purchase identifier.

property purchaseTime

DateTime? purchaseTime;

Purchase time (optional parameter).

property purchaseType

PurchaseType purchaseType;

Purchase type.

property quantity

Quantity quantity;

Product quantity.

property status

ProductPurchaseStatus status;

Purchase status.

property sandbox

bool sandbox;

Determines whether the payment is test. Values can be true or false, where true denotes a test payment and false denotes a real payment.

property acknowledgementState

AcknowledgementState acknowledgementState;

Purchase acknowledgment state.

---