JSON API » transactions » transactions/create

Creates a new 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
customer	Integer	ID of customer to create for.	Yes
amount	Decimal	Amount of transaction.	Recommended	0.00
currency	String	Currency amount is in.	Recommended	System currency.
description	String	Description.	Recommended	Empty string.
charge	Integer	ID of charge transaction is for. 0 for none.	No	0
invoice	Integer	ID of invoice transaction is shown on. 0 for none.	No	0
taxes	String	Comma separated list of taxes to apply.	No	Empty string.
time	Integer	Unix timestamp transaction occurred at.	No	Now.
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
200	Success.
201	Input passed validation. Only returned if validation=1.
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.

Data returned

The ID of the created transaction.

Example: With required and recommended parameters

http://enswitch.example.com/api/json/transactions/create/?auth_username=user;auth_password=password;customer=123;amount=10.00;currency=USD;description=example+transaction

{ "responses":[ { "code":"200", "key":"", "message":"OK" } ], "data":{ "id":123 } }

Change history

Version	Changes
3.13	Function added.