Payments Change Types

Change types that represent data modifications made to the Payments entity.

Change types

Add Interface Interaction

Change triggered by the Add InterfaceInteraction update action.
type​
String​
"AddInterfaceInteractionChange"
change​
String​
"addInterfaceInteraction"
nextValue​

Value after the change.

Add Transaction

Change triggered by the Add Transaction update action.
type​
String​
"AddTransactionChange"
change​
String​
"addTransaction"
nextValue​
Transaction​

Value after the change.

Change Amount Planned

Change triggered by the Change AmountPlanned update action.
type​
String​
"ChangeAmountPlannedChange"
change​
String​
"changeAmountPlanned"
previousValue​

Value before the change.

nextValue​

Value after the change.

Change Transaction Interaction ID

Change triggered by the Change TransactionInteractionId update action.
type​
String​
"ChangeTransactionInteractionIdChange"
change​
String​
"changeTransactionInteractionId"
previousValue​
String​

Value after the change.

nextValue​
String​

Value before the change.

transaction​

Holds information about the updated Transaction.

Change Transaction State

Change triggered by the Change TransactionState update action.
type​
String​
"ChangeTransactionStateChange"
change​
String​
"changeTransactionState"
previousValue​

Value before the change.

nextValue​

Value after the change.

transaction​

Holds information about the updated Transaction.

Change Transaction Timestamp

Change triggered by the Change TransactionTimestamp update action.
type​
String​
"ChangeTransactionTimestampChange"
change​
String​
"changeTransactionTimestamp"
previousValue​
String​

Value before the change.

nextValue​
String​

Value after the change.

transaction​

Holds information about the updated Transaction.

Set Anonymous ID

Change triggered by the Set AnonymousId update action.
type​
String​
"SetAnonymousIdChange"
change​
String​
"setAnonymousId"
previousValue​
String​

Value before the change.

nextValue​
String​

Value after the change.

Set Custom Field

Change triggered by the Set Custom Field update action.
type​
String​
"SetCustomFieldChange"
change​
String​
"setCustomField"
previousValue​
Any​

Value before the change.

nextValue​
Any​

Value after the change.

name​
String​
Name of the Custom Field.
customTypeId​
String​
id of the referenced Type.

Set Custom Type

Change triggered by the Set Custom Type update action.
type​
String​
"SetCustomTypeChange"
change​
String​
"setCustomType"
previousValue​

Value before the change.

nextValue​

Value after the change.

Set Customer

Change triggered by the Set Customer update action.
type​
String​
"SetCustomerChange"
change​
String​
"setCustomer"
previousValue​

Value before the change.

nextValue​

Value after the change.

Set Interface ID

Change triggered by the Set InterfaceId update action.
type​
String​
"SetInterfaceIdChange"
change​
String​
"setInterfaceId"
previousValue​
String​

Value before the change.

nextValue​
String​

Value after the change.

Set Key

type​
String​
"SetKeyChange"
change​
String​
"setKey"
previousValue​
String​

Value before the change.

nextValue​
String​

Value after the change.

Set Method Info Custom Field

Change triggered by the Set MethodInfo CustomField update action.
type​
String​
"SetMethodInfoCustomFieldChange"
change​
String​
"setMethodInfoCustomField"
name​
String​
Name of the Custom Field.
customTypeId​
String​
id of the referenced Type.
previousValue​
Any​

Value before the change.

nextValue​
Any​

Value after the change.

Example: json
{
  "type": "SetMethodInfoCustomFieldChange",
  "change": "setMethodInfoCustomField",
  "name": "reference",
  "customTypeId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "previousValue": "REF-1234",
  "nextValue": "REF-5678"
}

Set Method Info Custom Type

Change triggered by the Set MethodInfo CustomType update action.
type​
String​
"SetMethodInfoCustomTypeChange"
change​
String​
"setMethodInfoCustomType"
previousValue​

Value before the change.

nextValue​

Value after the change.

Example: json
{
  "type": "SetMethodInfoCustomTypeChange",
  "change": "setMethodInfoCustomType",
  "previousValue": {
    "type": {
      "typeId": "type",
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    },
    "fields": {
      "reference": "REF-1234"
    }
  },
  "nextValue": {
    "type": {
      "typeId": "type",
      "id": "ff8b0f8c-78c8-4c4c-a4b7-2545d9279515"
    },
    "fields": {
      "reference": "REF-5678"
    }
  }
}

Set Method Info Interface

Change triggered by the Set MethodInfoInterface update action.
type​
String​
"SetMethodInfoInterfaceChange"
change​
String​
"setMethodInfoInterface"
previousValue​
String​

Value before the change.

nextValue​
String​

Value after the change.

Set Method Info Interface Account

Change triggered by the Set MethodInfoInterfaceAccount update action.
type​
String​
"SetMethodInfoInterfaceAccountChange"
change​
String​
"setMethodInfoInterfaceAccount"
previousValue​
String​

Value before the change.

nextValue​
String​

Value after the change.

Example: json
{
  "type": "SetMethodInfoInterfaceAccountChange",
  "change": "setMethodInfoInterfaceAccount",
  "previousValue": "account-eu-001",
  "nextValue": "account-eu-002"
}

Set Method Info Method

Change triggered by the Set MethodInfoInterface update action.
type​
String​
"SetMethodInfoMethodChange"
change​
String​
"setMethodInfoMethod"
previousValue​
String​

Value before the change.

nextValue​
String​

Value after the change.

Set Method Info Name

Change triggered by the Set MethodInfoName update action.
type​
String​
"SetMethodInfoNameChange"
change​
String​
"setMethodInfoName"
previousValue​

Value before the change.

nextValue​

Value after the change.

Set Method Info Token

Change triggered by the Set MethodInfoToken update action.
type​
String​
"SetMethodInfoTokenChange"
change​
String​
"setMethodInfoToken"
Example: json
{
  "type": "SetMethodInfoTokenChange",
  "change": "setMethodInfoToken"
}

Set Status Interface Code

Change triggered by the Set StatusInterfaceCode update action.
type​
String​
"SetStatusInterfaceCodeChange"
change​
String​
"setStatusInterfaceCode"
previousValue​
String​

Value before the change.

nextValue​
String​

Value after the change.

Set Status Interface Text

Change triggered by the Set StatusInterfaceText update action.
type​
String​
"SetStatusInterfaceTextChange"
change​
String​
"setStatusInterfaceText"
previousValue​
String​

Value before the change.

nextValue​
String​

Value after the change.

Set Transaction Custom Field

Change triggered by the Set Transaction CustomField update action.
type​
String​
"SetTransactionCustomFieldChange"
change​
String​
"setTransactionCustomField"
transaction​

Holds information about the updated Transaction.

name​
String​
Name of the Custom Field.
customTypeId​
String​
id of the referenced Type.
previousValue​
Any​

Value before the change.

nextValue​
Any​

Value after the change.

Set Transaction Custom Type

Change triggered by the Set Transaction Custom Type update action.
type​
String​
"SetTransactionCustomTypeChange"
change​
String​
"setTransactionCustomType"
transaction​

Holds information about the updated Transaction.

previousValue​

Value before the change.

nextValue​

Value after the change.

Set Transaction Interface ID

Change triggered by the Set Transaction InterfaceId update action.
type​
String​
"SetTransactionInterfaceIdChange"
change​
String​
"setTransactionInterfaceId"
transaction​

Holds information about the updated Transaction.

previousValue​
String​

Value before the change.

nextValue​
String​

Value after the change.

Transition State

Change triggered by the Transition State update action.
type​
String​
"TransitionStateChange"
change​
String​
"transitionState"
previousValue​

Value before the change.

nextValue​

Value after the change.