/
v3.0.11Get access

processCashbackCashout

Processes the cashback cashout based on the specified bonus definition

Request parameters:

NameDescriptionTypeValuesDefaultSource
bonusDefinitionId
ID of the bonus definition to process the cashback cashout for.number--
Key from responsebonus_definition_id
This method is usually used with these methods:

Call example:

processCashbackCashout({
  bonusDefinitionId: 636
})

Response examples:

{
  code: 0,
  rid: '5c74b081336b0747674c5787d7cc583c3b8f9ebe',
  data: {
    result: 0,
    details: {
      '$id': '1',
      Amount: 75,
      HasError: false,
      ErrorId: 0,
      ErrorDescription: null,
      ErrorValue: null
    }
  }
}

Response parameters:

NameDescriptionTypeValues
$id
An internal reference ID for the object instancestring-
Amount
The total amount of cashback that was successfully converted or cashed outnumber-
HasError
A flag indicating if the specific business logic failedbooleantrue / false
ErrorId
A specific error code for the cashback logicnumber-
ErrorDescription
Readable message explaining why the cashout failedstring-
ErrorValue
Provides specific data context for an errorstring-