revertBalanceChange( )


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

This method may require higher-level permissions than the caller has, based on their identity and roles and permissions. In these cases, you can ensure the method is called with the required level of authorization by using one of the following:

Permissions
SCOPE.BENEFIT_PROGRAMS.MANAGE
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
idempotencyKeystringRequired

Ignored value, kept for backward compatibility. Idempotency is now handled by the system.


transactionIdstringRequired

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


optionsRevertBalanceChangeOptions
Returns
Return Type:Promise<RevertBalanceChangeResponse>
Errors
404Not Found

There is 1 error with this status code.

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?