Update
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 packet.
Original transaction is determined by the Update transaction using the following parameters: OriginalTransactioID, SubAccountID, AccountID.
Use regular Echo request packet for Update transactions.
Update transaction packet must include:
- parent transaction id
- parent transaction id type
See code sample of the request in the Echo Request section.
Request Parameters
Transaction Packet
| Name | Type | Required | Description | |||||||||||||||||||||
| accountId | integer | ✓ | Platform Account identifier. Disabled for updating by the Update transaction. | |||||||||||||||||||||
| amount | decimal | ✓ | Transaction amount. The value of ‘Amount’ must be empty or null for Type=’Update’ | |||||||||||||||||||||
| 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:
| |||||||||||||||||||||
| entryMode | integer | optional | Nullable Transaction entry mode numerical value. | |||||||||||||||||||||
| merchantData | object | optional | Merchant Data data object. | |||||||||||||||||||||
| originalTransaction | object | ✓ | Original Transaction data object. Disabled for updating by the Update transaction. | |||||||||||||||||||||
| processorData | object | optional | Processor Data data object. | |||||||||||||||||||||
| chargeBack | object | optional | Additional chargeback parameters. | |||||||||||||||||||||
| subAccountId | integer | ✓ | Sub-Account identifier. Disabled for updates by Update transactions. | |||||||||||||||||||||
| terminalId | string | optional | Terminal identifier. | |||||||||||||||||||||
| type | enum | ✓ | transactionTypeId. Disabled for updates by Update transactions. Available Values:
|
{
"accountId": "Platform Account Id",
"amount": null,
"billingAddress": {
"addressLine": "Update-AddressLine",
"city": "Update-City",
"country": "Update-Country",
"email": "Update-Email",
"phoneNumber": "Update-Phone",
"state": "Update-State",
"zipPostalCode": "Update-ZIP"
},
"billingOverride": [
{
"fixedAmount": "feeFixedAmountValue",
"id": "objectIdentifier",
"percentageAmount": "feePercentageAmountValue",
"billingAmount": "billingAmountValue"
}
],
"originalTransaction": {
"transactionId": "732000000002107745",
"transactionType": "merchant"
},
"currency":"USD",
"entryMode":100,
"merchantData": {
"freeText": "Update MerchantText",
"transactionDate": "2023-04-18T05:28:16",
"transactionDescription": "Update Description",
"transactionId": "UpdateMerchantTrxID"
},
"processorData": {
"authorizationNumber": "AK00z",
"avsResultIndication": "DDD",
"cvvResultIndication": "PPP",
"transactionId": "UpdateTrxAqcTrxID"
},
"chargeback": {
"disputeDate": "string",
"reasonCode": "string"
},
"subAccountId": "Sub-Account Id",
"terminalId": "777",
"type": "Update"
}