/
v3.0.11Get access

getContainerCollectState

Retrieves the real-time status and balance of a specific reward container (cashback reserve) associated with the user's account

Request parameters:

NameDescriptionTypeValuesDefaultSource
sourceId
SourceId is the same partner siteIdnumber--
MethodsubscribeToPartnerConfig
Key from responsepartner_id

Parameters marked with must be included in the request

Call example:

getContainerCollectState({
  sourceId: 18767498
})

Response examples:

{
  ErrorId: 0,
  ErrorDescription: '',
  HasError: false,
  Result: {
    CurrencyId: 'RUB',
    IsAvailable: true,
    Amount: 41.12
  }
}

Response parameters:

NameDescriptionTypeValues
CurrencyId
The ISO currency code in which the accumulated reward is denominatedstring-
IsAvailable
Indicates if the "Collect" action is currently enabled for the user based on business rules or minimum thresholdsbooleantrue / false
Amount
The total numerical value currently sitting in the vault ready to be collectednumber-