revertBalanceChange( )

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Reverts a transaction created by calling Change Balance.

For example, if a transaction increased a balance's available credits by 5, calling Revert Balance Change with the transaction's ID will decrease the balance's available credit by 5.

Note: If the Change Balance call set the balance, Revert Transaction reverts the amount the balance changed by, ensuring subsequent balance changes are still reflected after the reversion.

Authentication
  • When developing websites or building an app with Blocks, this method may require elevated permissions, depending on the identity of the user calling it and the calling user’s permissions.
  • When building apps without Blocks or for headless projects, you can only call this method directly when authenticated as a Wix app or Wix user identity. When authenticated as a different identity, you can call this method using elevation.
  • Elevation permits users to call methods they typically cannot access. Therefore, you should only use it intentionally and securely.
Permissions
SCOPE.BENEFIT_PROGRAMS.MANAGE
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
transactionIdstringRequired

ID of the transaction associated with the balance change to revert.

idempotencyKeystringRequired

Unique identifier, generated by the client. Used to recognize repeated attempts to make the same request.

optionsRevertBalanceChangeOptions
Returns
Return Type:Promise<RevertBalanceChangeResponse>
Errors
428Failed Precondition

There are 2 errors with this status code.

This method may also return standard errors. Learn more about standard Wix errors.

Did this help?
OSZAR »