JSON API » customers » customers/balance/add

Increases a customer's balance. It's better to use this than customers/update as this is atomic.

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 customer to update.	Yes
amount	Decimal	The amount to add.	Yes
currency	String	The currency the amount is in.	No	The customer's currency.
transaction	String	"credit" to record a credit transaction, "topup" to record a topup transaction (use with caution), empty string to record no transaction.	No	Empty string.
description	String	The description of the transaction.	No	Empty string.

Responses

Code	Description
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 customer does not exist, or you do not have permission to update it.

Data returned

No data is returned.

Example: With required parameters

http://enswitch.example.com/api/json/customers/balance/add/?auth_username=user;auth_password=password;id=123;amount=100.00

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

Change history

Version	Changes
3.13	Function added.