VersaCloud API ′GroupBalanceTransferAllow′ Reference Documentation

Description

The following table displays the documentation for the 'GroupBalanceTransferAllow' API in all languages currently available:

Parameters

The following table describes all of 'GroupBalanceTransferAllow''s parameters, in every language available.

ID: 1 - Name: Login

Language: English (United States)

Description: Operation handle returned from succesful call of UserLoginAllow, identifying group administrator

Type: operationhandle - Min-Max Length: 48-48 - Reentr Key Member: No - Optional: No

ID: 2 - Name: GroupName

Language: English (United States)

Description: Name of group from which balance will be transferred to a specific user

Type: group - Min-Max Length: 4-32 - Reentr Key Member: Yes - Optional: No

ID: 3 - Name: UserToCredit

Language: English (United States)

Description: E-mail address of user to receive the balance transfer

Type: email - Min-Max Length: 7-128 - Reentr Key Member: Yes - Optional: No

ID: 4 - Name: Amount

Language: English (United States)

Description: Amount (in VersaCoin cents) to be transferred

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 administrador del grupo

Type: operationhandle - Min-Max Length: 48-48 - Reentr Key Member: No - Optional: No

ID: 2 - Name: GroupName

Language: Español (moderno)

Description: Nombre del grupo a partir del cual serán transferidos créditos para un usuario específico

Type: group - Min-Max Length: 4-32 - Reentr Key Member: Yes - Optional: No

ID: 3 - Name: UserToCredit

Language: Español (moderno)

Description: Dirección de correo electrónico del usuario que recibirá la transferencia de créditos

Type: email - Min-Max Length: 7-128 - Reentr Key Member: Yes - Optional: No

ID: 4 - Name: Amount

Language: Español (moderno)

Description: Monto (en centavos de VersaCoins) a ser transferido

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 o administrador do grupo

Type: operationhandle - Min-Max Length: 48-48 - Reentr Key Member: No - Optional: No

ID: 2 - Name: GroupName

Language: Português (Brasil)

Description: Nome do grupo a partir do qual serão transferidos créditos para um usuário específico

Type: group - Min-Max Length: 4-32 - Reentr Key Member: Yes - Optional: No

ID: 3 - Name: UserToCredit

Language: Português (Brasil)

Description: Endereço de e-mail do usuário que receberá a transferência de créditos

Type: email - Min-Max Length: 7-128 - Reentr Key Member: Yes - Optional: No

ID: 4 - Name: Amount

Language: Português (Brasil)

Description: Montante (em centavos de VersaCoins) a ser transferido

Type: versadime - Min-Max Length: 1-11 - Reentr Key Member: No - Optional: No

---

Return Value

'GroupBalanceTransferAllow' 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 'GroupBalanceTransferAllow' API (generic errorcodes like wrong number of parameters or invalid values for parameters' types are not listed):

US Patent Requested