Home Page
English (1.186)
VersaCloud (1.163)
VersaCloud API ′UserBalanceAddAllow′ Reference Documentation
Description
The following table displays the documentation for the 'UserBalanceAddAllow' API in all languages currently available:
Language |
Documentation |
|---|---|
English (United States) |
Requests the addition of a certain amount of VersaCoins to user's balance |
Español (moderno) |
Pide a la adición de una cierta cantidad de VersaCoins al saldo del usuario |
Português (Brasil) |
Solicita a adição de uma certa quantidade de VersaCoins ao saldo do usuário |
Parameters
The following table describes all of 'UserBalanceAddAllow''s parameters, in every language available.
ID: 1 - Name: Login
Language: English (United States)
Description: Operation handle returned from succesful call of UserLoginAllow, identifying balance manager attributing credit to user
Type: operationhandle - Min-Max Length: 48-48 - Reentr Key Member: No - Optional: No
ID: 2 - Name: UserToCredit
Language: English (United States)
Description: E-mail address of user to receive the new credit of VersaCoins
Type: email - Min-Max Length: 7-128 - Reentr Key Member: Yes - Optional: No
ID: 3 - Name: Amount
Language: English (United States)
Description: Amount (in VersaCoin cents) to be credited
Type: versadime - Min-Max Length: 1-11 - Reentr Key Member: No - Optional: No
ID: 1 - Name: Login
Language: Español (moderno)
Description: Protocolo de operación obtenido de llamada exitosa a UserLoginAllow, identificando al gerente de saldo atribuindo crédito al usuário
Type: operationhandle - Min-Max Length: 48-48 - Reentr Key Member: No - Optional: No
ID: 2 - Name: UserToCredit
Language: Español (moderno)
Description: Dirección de correo electrónico del usuario que recibirá el nuevo crédito de VersaCoins
Type: email - Min-Max Length: 7-128 - Reentr Key Member: Yes - Optional: No
ID: 3 - Name: Amount
Language: Español (moderno)
Description: Monto (en centavos de VersaCoins) a ser creditado
Type: versadime - Min-Max Length: 1-11 - Reentr Key Member: No - Optional: No
ID: 1 - Name: Login
Language: Português (Brasil)
Description: Protocolo de operação retornado por chamada bem sucedida a UserLoginAllow, identificando gerente de saldo atribuindo crédito ao usuário
Type: operationhandle - Min-Max Length: 48-48 - Reentr Key Member: No - Optional: No
ID: 2 - Name: UserToCredit
Language: Português (Brasil)
Description: Endereço de e-mail do usuário que receberá o novo crédito de VersaCoins
Type: email - Min-Max Length: 7-128 - Reentr Key Member: Yes - Optional: No
ID: 3 - Name: Amount
Language: Português (Brasil)
Description: Montante (em centavos de VersaCoins) a ser creditado
Type: versadime - Min-Max Length: 1-11 - Reentr Key Member: No - Optional: No
---
Return Value
'UserBalanceAddAllow' returns a value of type operationhandle (minimum length of returned values is 48 characters characters, while maximum length of returned values is 48 characters characters).
Please note that all APIs returning values of types that allow for localized values (like e.g. boolean or country) always return the standard type values.
Specific Error Codes
If an error happens during the execution of any VersaCloud call, an errorcode is returned instead of the standard return value described above.
The following table lists errorcodes returned specifically by the 'UserBalanceAddAllow' API (generic errorcodes like wrong number of parameters or invalid values for parameters' types are not listed):
Errorcode |
Language |
Description |
|---|---|---|
:@Err#Bal0000007 |
English (United States) |
No user is allowed to add any amount of versacoins to his own balance |
:@Err#Usr0000002 |
English (United States) |
Value provided as user e-mail is not registered with VersaCloud |
:@Err#Bal0000007 |
Español (moderno) |
Ningún usuario está autorizado a adicionar cualquier monto de versacoins a su proprio saldo |
:@Err#Usr0000002 |
Español (moderno) |
Valor informado como correo electrónico de usuario no está registrado en VersaCloud |
:@Err#Bal0000007 |
Português (Brasil) |
Nenhum usuário é autorizado a adicionar qualquer montante de versacoins a seu próprio saldo |
:@Err#Usr0000002 |
Português (Brasil) |
Valor informado como e-mail de usuário não está registrado em VersaCloud |
US Patent Requested
