Allows you to transfer credits from your account to another account on the same site.
Note: transferring of credits may need to be enabled for your account, before you can use this feature. Please contact Support to request this, if needed.
Required parameters
(Parameter values should be encoded in ISO-8859-1)
- username
- password
- to_username: the username of the recipient account you want to transfer credits to.
- to_userid: the numeric userid of the recipient account. We require both the username and userid to avoid mistakes.
- credits: the positive integer number of credits to transfer to the recipient account.
Optional parameters
- from_comment: will appear in the transferring account's credit history. You might use this to record you own internal tracking reference, for example.
- to_comment: will appear in the recipient account's credit history.
Returns:
status_code|status_description
Possible values for status_code are:
- 0: success (credits were transferred)
- 22: An internal error occured. Please contact Support.
- 25: You do not have sufficient credits
- 41: Your account is not enabled for credit transfers. Please contact Support.
- 42: The specified recipient account does not exist: either the to_username or to_userid is incorrect.
- 43: One of the parameters was invalid, e.g. a negative or zero credit amount.
You should never depend on the value of status_description - only depend on status_code, which is a constant. However, status_description can contain useful information about the nature of failures when you are developing your initial application.
Any HTTP status code other than 200 should be considered transient, i.e. you should try again after some interval.
URL
The current url is:
URL: http://community.bulksms.co.uk:5567/eapi/user/transfer_credits/1/1.0