Adjustment
Use Update transaction to send updated values of commissions and fees of the original transaction with the Update transaction request. With the Update transaction request it is also possible to change a number of other original transaction parameters. When creating an Update transaction, the system does not update the transaction itself, but specific transaction parameters by the updated values passed with Update transaction request packet.
Original transaction is determined by the Update transaction using the following original transaction parameters: transactionId, subAccountId, accountId.
Update transaction cannot be processed on another Update transaction.
Update transaction packet must include originalTransaction object.
Update transaction packet must include originalTransaction object.
Parameters that cannot be updated are marked appropriately in the Request Parameters table.
Request Parameters
| Name | Type | Required | Description | |||||||||||||||||||||
| accountId | integer | ✓ | Platform Account identifier. Muset be greater than 0. Disabled for updating by the Update transaction. | |||||||||||||||||||||
| amount | decimal | ✓ | Transaction amount. Value ≥ 0 (2 decimal places) Amount=0 can be passed with Update transaction type. | |||||||||||||||||||||
| billingAddress | object | optional | User Billing Address data object. | |||||||||||||||||||||
| billingOverride | object | optional | Data object that contains an array of billingFee objects. | |||||||||||||||||||||
| currency | enum | ✓ | CurrencyTypeId. Disabled for updating by the Update transaction. Available Values:
| |||||||||||||||||||||
| merchantData | object | optional | Merchant Data data object. | |||||||||||||||||||||
| subAccountId | integer | ✓ | Sub-Account identifier. Value ≥ 0 Disabled for updating by the Update transaction. | |||||||||||||||||||||
| terminalId | string | optional | Terminal identifier. MaxLength(20) | |||||||||||||||||||||
| type | enum | ✓ | transactionTypeId. Disabled for updating by the Update transaction. Available Values:
| |||||||||||||||||||||
| chargeback | object | conditional | Additional chargeback parameters. Null if transaction “type“ ≠ “Chargeback” and “Update“ conditional if transaction “type“ = “Chargeback” or “Update“ | |||||||||||||||||||||
| originalTransaction | object | ✓ | Original Transaction data object. Disabled for updating by the Update transaction. |
//Update request example
{
"accountId": "Platform Account Id",
"subAccountId": "Sub-Account Id",
"amount": 10,
"currency": "USD",
"type": "Update",
"originalTransaction": {
"transactionId": "Transaction Id",
"transactionType": "System"
},
"billingOverride": [
{
"fixedAmount": "feeFixedAmount",
"id": "objectId",
"percentageAmount": "feePercentageAmount",
"sourceId": "feeSourceIdentifier",
"sourceType": "BillingAccountId",
"targetId": "feeTargetIdentifier",
"targetType": "BillingAccountId",
"reverse": "true",
"billingAmount": "billingAmountValue"
}
],
"terminalId": "string",
"transactionMethod": "RegularTransaction",
"billingAddress": {
"addressLine": "Address",
"city": "City Name",
"country": "USA",
"email": "email@mail.com",
"phoneNumber": "12346879",
"state": "FL",
"zipPostalCode": "123465798"
},
"merchantData": {
"freeText": "string",
"transactionDate": "dateTime",
"transactionDescription": "string",
"transactionId": "string"
}
}