• User Documentation 
  • Amaryllis Release Notes 
  • For Developers 

  • User Documentation 
  • Amaryllis Release Notes 
  • For Developers 

Dev Portal

  • folder icon closed folder iconIntroduction
  • folder icon closed folder iconAuthentication
  • folder icon closed folder iconManagement
    • Getting Started
    • Platform Accounts Management
      • Get Platform Account Configuration
      • Get Platform Account
      • Create Platform Account
      • Update Platform Account
      • Objects Reference
    • Sub-Accounts Management
      • Get Sub-Account Configurations
      • Get Sub-Account
      • Create Sub-Account
      • Update Sub-Account
      • Objects Reference
    • Users Management
      • Get User by User Id
      • Get User by Username
      • Create User
      • Update User
      • Objects Reference
    • Underwriting Management
      • Get Application
      • Get Application Template
      • Get Application Fields Statuses
      • Get Application Status
      • Get Linked Sub-Accounts
      • Get Resubmission
      • UMS IFrame Authentication
      • UMS IFrame
      • UMS IFrame Authentication in Resubmission Mode
      • UMS IFrame in Resubmission Mode
      • Create Application
      • Update Application
      • Update Application Fields Statuses
      • Update Application Status
      • Objects Reference
      • Response Codes
  • folder icon closed folder iconTransactions Processing
    • Getting Started
    • Credit Card Transactions
      • 3D-Secure
      • Authorization
      • Void
      • Capture
      • Charge
      • Refund
      • Credit
      • Verify
      • Chargeback
      • Cancel
    • Update
    • Adjustment
    • Recurring
    • ACH
    • Response
    • Response Codes
    • Objects Reference
  • folder icon closed folder iconTransactions Echo
    • Getting Started
    • Credit Card Transactions
      • Authorization
      • Void
      • Capture
      • Charge
      • Refund
      • Credit
      • Verify
      • Chargeback
      • Cancel
    • Update
    • Adjustment
    • ACH
    • Echo Response
    • Response Codes
    • Objects Reference
  • folder icon closed folder iconTokenization
    • Processing with a Token
      • Getting Started
      • Processing with Tokenization
    • Tokenization iFrame
      • iFrame Integration
      • iFrame Customization
      • iFrame Testing
      • Response Example
    • Tokenization API
      • Getting Started
      • Tokenization Request
      • Tokenization Response
      • Response Codes
  • folder icon closed folder iconPayouts
    • Getting Started
    • Payout Transactions
    • Response
    • Objects Reference
  • folder icon closed folder iconReports
    • Getting Started
    • Reports API
      • Account Balances
      • Payouts
      • Payouts Reconciliation
      • Settlements
      • Transaction Details
      • Account Summary
      • Transactions Summary
      • Transactions
      • Fees Summary
      • Incoming Fees
      • Expected Future Revenue
      • Profitability Analysis
      • Reconciliation Summary
      • Reconciliation Records
      • Chargeback Analysis
      • Tokens
      • Sign-up Summary
    • Status Codes
  • folder icon closed folder iconErrors
  • folder icon closed folder iconResponse Codes
  1. Home
  2. Docs
  3. Dev Portal
  4. Transactions Processing
  5. Update
Updated on May 17, 2023

Dev Portal

  • folder icon closed folder iconIntroduction
  • folder icon closed folder iconAuthentication
  • folder icon closed folder iconManagement
    • Getting Started
    • Platform Accounts Management
      • Get Platform Account Configuration
      • Get Platform Account
      • Create Platform Account
      • Update Platform Account
      • Objects Reference
    • Sub-Accounts Management
      • Get Sub-Account Configurations
      • Get Sub-Account
      • Create Sub-Account
      • Update Sub-Account
      • Objects Reference
    • Users Management
      • Get User by User Id
      • Get User by Username
      • Create User
      • Update User
      • Objects Reference
    • Underwriting Management
      • Get Application
      • Get Application Template
      • Get Application Fields Statuses
      • Get Application Status
      • Get Linked Sub-Accounts
      • Get Resubmission
      • UMS IFrame Authentication
      • UMS IFrame
      • UMS IFrame Authentication in Resubmission Mode
      • UMS IFrame in Resubmission Mode
      • Create Application
      • Update Application
      • Update Application Fields Statuses
      • Update Application Status
      • Objects Reference
      • Response Codes
  • folder icon closed folder iconTransactions Processing
    • Getting Started
    • Credit Card Transactions
      • 3D-Secure
      • Authorization
      • Void
      • Capture
      • Charge
      • Refund
      • Credit
      • Verify
      • Chargeback
      • Cancel
    • Update
    • Adjustment
    • Recurring
    • ACH
    • Response
    • Response Codes
    • Objects Reference
  • folder icon closed folder iconTransactions Echo
    • Getting Started
    • Credit Card Transactions
      • Authorization
      • Void
      • Capture
      • Charge
      • Refund
      • Credit
      • Verify
      • Chargeback
      • Cancel
    • Update
    • Adjustment
    • ACH
    • Echo Response
    • Response Codes
    • Objects Reference
  • folder icon closed folder iconTokenization
    • Processing with a Token
      • Getting Started
      • Processing with Tokenization
    • Tokenization iFrame
      • iFrame Integration
      • iFrame Customization
      • iFrame Testing
      • Response Example
    • Tokenization API
      • Getting Started
      • Tokenization Request
      • Tokenization Response
      • Response Codes
  • folder icon closed folder iconPayouts
    • Getting Started
    • Payout Transactions
    • Response
    • Objects Reference
  • folder icon closed folder iconReports
    • Getting Started
    • Reports API
      • Account Balances
      • Payouts
      • Payouts Reconciliation
      • Settlements
      • Transaction Details
      • Account Summary
      • Transactions Summary
      • Transactions
      • Fees Summary
      • Incoming Fees
      • Expected Future Revenue
      • Profitability Analysis
      • Reconciliation Summary
      • Reconciliation Records
      • Chargeback Analysis
      • Tokens
      • Sign-up Summary
    • Status Codes
  • folder icon closed folder iconErrors
  • folder icon closed folder iconResponse Codes

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 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.
 
Parameters that cannot be updated are marked appropriately in the Request Parameters table.

Request Parameters

 NameTypeRequiredDescription
 accountIdinteger✓Platform Account identifier.
Muset be greater than 0.
Disabled for updating by the Update transaction.
 amountdecimal✓Transaction amount.
Value ≥ 0 (2 decimal places)
Amount=0 can be passed with Update transaction type.
 billingAddressobjectoptionalUser Billing Address data object.
 billingOverrideobjectoptionalData object that contains an array of billingFee objects.
 currencyenum✓CurrencyTypeId.
Disabled for updating by the Update transaction.
Available Values:
 
CurrencyId
USD1
EUR2
CAD6
GBP4
AUD5
SGD11
JPY23
NZD32
ILS8
 merchantDataobjectoptionalMerchant Data data object.
 subAccountIdinteger✓Sub-Account identifier.
Value ≥ 0
Disabled for updating by the Update transaction.
 terminalIdstringoptionalTerminal identifier.
MaxLength(20)
 typeenum✓transactionTypeId.
Disabled for updating by the Update transaction.
Available Values:
 
Update
 chargebackobjectconditionalAdditional chargeback parameters.
Null if transaction “type“ ≠ “Chargeback” and “Update“
conditional if transaction “type“ = “Chargeback” or “Update“
 originalTransactionobject✓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"
  }
}				
			
Still stuck? How can we help?
Was this page helpful? Yes No

How can we help?

© Amaryllis Payment Solutions, 2022  All rights reserved.