Skip to content

Rule Effect

paymentCommand

Back to Index

Return this effect to apply a payment command from hooks that supports it.

Type

{
effect: 'paymentCommand'
type: text // Command type
// Additional command properties are added here
}

Payment Commands

addActivityLog

Adds an activity log to a Payment

addTag

Adds a tag to a Payment

createAuthorization

Creates a new Authorization.

generatePaymentNumberByPrefix

Generates a payment number for a payment based on the given prefix

removeTag

Removes a tag from a Payment

setAuthorizationAmount

Sets the amount of an Authorization.

setAuthorizationState

Sets the state of an Authorization.

setDynamicFields

Sets dynamic fields of a payment. Non specified fields will be left unchanged. Set value to null to remove field.

Back to Index