JSON API » transactions » transactions/update

Updates an existing transaction.

Input parameters

Requires authentication and the commerce role privilege.

Name	Type	Description	Required	Default value
auth_username	String	Authentication username.	Yes
auth_password	String	Authentication password.	Yes
id	Integer	ID of transaction to update.	Yes
amount	Decimal	Amount of transaction.	No	Current value.
currency	String	Currency amount is in.	No	Current value.
description	String	Description.	No	Current value.
taxes	String	Comma separated list of taxes to apply.	No	Current value.
time	Integer	Unix timestamp transaction occurred at.	No	Current value.
update_balance	Integer	1 to update balance of customer, 0 not to.	No	1
update_invoices	Integer	1 to update any affected invoices, 0 not to.	No	1
validation	Integer	1 to validate input then return, 0 for full action.	No	0

Positive amounts increase the customer's balance, negative amounts decrease the customer's balance.

Responses

Code	Description
201	Input passed validation. Only returned if validation=1.
204	Success.
400	Invalid input parameters specified. Check the key and message fields for more details.
401	The authentication details provided are invalid.
402	Your role does not allow this.
404	The transaction does not exist, or you do not have permission to update it.

Data returned

No data is returned.

Example: Changing the amount

http://enswitch.example.com/api/json/transactions/update/?auth_username=user;auth_password=password;id=123;amount=10.00;currency=USD

{ "responses":[ { "code":"204", "key":"", "message":"OK" } ] }

Change history

Version	Changes
3.13	Function added.