Description

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

Language

Documentation

English (United States)

Requests transferring (part of) a group's balance to another user

Español (moderno)

Solicita la transferencia de (parte del) saldo de un grupo para otro usuario

Português (Brasil)

Solicita a transferência de (parte do) saldo de um grupo para outro usuário

Parameters

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

ID

Name

Language

Description

Type

Min-Max Length

Reentr Key Member

Optional

1

Login

English (United States)

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

operationhandle

48-48

No

No

2

GroupName

English (United States)

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

group

4-32

Yes

No

3

UserToCredit

English (United States)

E-mail address of user to receive the balance transfer

email

7-128

Yes

No

4

Amount

English (United States)

Amount (in VersaCoin cents) to be transferred

versacoin

1-11

No

No

1

Login

Español (moderno)

Protocolo de operación obtenido de llamada exitosa a UserLoginAllow, identificando al administrador del grupo

operationhandle

48-48

No

No

2

GroupName

Español (moderno)

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

group

4-32

Yes

No

3

UserToCredit

Español (moderno)

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

email

7-128

Yes

No

4

Amount

Español (moderno)

Monto (en centavos de VersaCoins) a ser transferido

versacoin

1-11

No

No

1

Login

Português (Brasil)

Protocolo de operação retornado por chamada bem sucedida a UserLoginAllow, identificando o administrador do grupo

operationhandle

48-48

No

No

2

GroupName

Português (Brasil)

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

group

4-32

Yes

No

3

UserToCredit

Português (Brasil)

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

email

7-128

Yes

No

4

Amount

Português (Brasil)

Montante (em centavos de VersaCoins) a ser transferido

versacoin

1-11

No

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):

Errorcode

Language

Description

:@Err#Grp0000021

English (United States)

User is not yet a member of specified usergroup

:@Err#Grp0000041

English (United States)

Login provided is not an administrator of specified group

:@Err#Grp0000051

English (United States)

Group's current balance is not enough

:@Err#Grp0000055

English (United States)

Group's balance consumption speed limit has been reached

:@Err#Grp0000021

Español (moderno)

Usuario todavía no es miembro del grupo de usuarios indicado

:@Err#Grp0000041

Español (moderno)

El login proveído no es administrador del grupo especificado

:@Err#Grp0000051

Español (moderno)

El saldo actual del grupo es insuficiente

:@Err#Grp0000055

Español (moderno)

Se alcanzó el límite de velocidad de consumo del saldo del grupo

:@Err#Grp0000021

Português (Brasil)

Usuário ainda não é membro do grupo de usuários especificado

:@Err#Grp0000041

Português (Brasil)

O login fornecido não é administrador do grupo especificado

:@Err#Grp0000051

Português (Brasil)

O saldo atual do group não é suficiente

:@Err#Grp0000055

Português (Brasil)

Foi alcançado o limite de velocidade de consumo do saldo do grupo

US Patent Requested