Description

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

Language

Documentation

English (United States)

Deducts a specific amount of credit for a specific transaction, on behalf of a back-end server

Español (moderno)

Debita una cantidad determinada de crédito para una transacción específica, por cuenta de un servidor de back-end

Português (Brasil)

Debita uma quantia determinada de crédito para uma transação específica, por conta de um servidor de back-end

Parameters

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

ID

Name

Language

Description

Type

Min-Max Length

Reentr Key Member

Optional

1

MethodInvokeAllow

English (United States)

Operation handle returned from succesful call of MethodInvokeAllow that started the transaction

operationhandle

48-48

No

No

2

SolutionToken

English (United States)

Back-end Token of Solution requesting transaction's data

solutiontoken

128-128

No

No

3

Amount

English (United States)

Amount of credit (in VersaCoin cents) to be debited from user's account

versacoin

1-10

No

No

1

MethodInvokeAllow

Español (moderno)

Protocolo de operación resultante de una llamada exitosa a MethodInvokeAllow que inició la transacción

operationhandle

48-48

No

No

2

SolutionToken

Español (moderno)

Token de back-end de la solución que está pidiendo datos de una transacción

solutiontoken

128-128

No

No

3

Amount

Español (moderno)

Cantidad de créditos (en centavos de VersaCoin) a ser debitados de la cuenta del usuario

versacoin

1-10

No

No

1

MethodInvokeAllow

Português (Brasil)

Protocolo de operação resultante de uma chamada bem sucedida a MethodInvokeAllow que iniciou a transação

operationhandle

48-48

No

No

2

SolutionToken

Português (Brasil)

Token de back-end da solução que está solicitando dados de uma transação

solutiontoken

128-128

No

No

3

Amount

Português (Brasil)

Quantidade de créditos (em centavos de VersaCoin) a serem debitados da conta do usuário

versacoin

1-10

No

No

Return Value

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

Errorcode

Language

Description

:@Err#Bal0000000

English (United States)

User's current balance is insufficient to run this call

:@Err#Bal0000003

English (United States)

Group's current balance is insufficient to run this call

:@Err#Bal0000013

English (United States)

UserBalanceCharge should not be called to charge zero

:@Err#Grp0000055

English (United States)

Group's balance consumption speed limit has been reached

:@Err#Grp0000058

English (United States)

Method call implies in trying to charge an non-existing group

:@Err#Oph0000027

English (United States)

Operation Handle does not correspond to a pending transaction

:@Err#Sol0000006

English (United States)

Solution Token is not valid

:@Err#Sol0000018

English (United States)

Solution Token type must be of type 'B' (back-end)

:@Err#Usr0000055

English (United States)

User's balance consumption speed limit has been reached

:@Err#Usr0000058

English (United States)

Method call implies in trying to charge an non-existing user

:@Err#Bal0000000

Español (moderno)

Saldo actual del usuario no es suficiente para ejecutar esta llamada

:@Err#Bal0000003

Español (moderno)

Saldo actual del grupo no es suficiente para ejecutar esta llamada

:@Err#Bal0000013

Español (moderno)

UserBalanceCharge no debe ser llamada para debitar cero

:@Err#Grp0000055

Español (moderno)

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

:@Err#Grp0000058

Español (moderno)

La llamada del método implica en una tentativa de debitar un grupo inexistente

:@Err#Oph0000027

Español (moderno)

Protocolo de operación no corresponde a una transacción pendiente

:@Err#Sol0000006

Español (moderno)

Token de solución no es válido

:@Err#Sol0000018

Español (moderno)

Tipo de token de solución tiene que ser B ('back-end')

:@Err#Usr0000055

Español (moderno)

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

:@Err#Usr0000058

Español (moderno)

La llamada del método implica en una tentativa de debitar un usuario inexistente

:@Err#Bal0000000

Português (Brasil)

Saldo atual do usuário é insuficiente para executar esta chamada

:@Err#Bal0000003

Português (Brasil)

Saldo atual do grupo é insuficiente para executar esta chamada

:@Err#Bal0000013

Português (Brasil)

UserBalanceCharge não deve ser chamada para debitar zero

:@Err#Grp0000055

Português (Brasil)

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

:@Err#Grp0000058

Português (Brasil)

A chamada do método implica na tentativa de debitar um grupo inexistente

:@Err#Oph0000027

Português (Brasil)

Protocolo de operação não corresponde a uma transação pendente

:@Err#Sol0000006

Português (Brasil)

Token de solução não é válido

:@Err#Sol0000018

Português (Brasil)

Tipo de token de solução tem que ser B ('back-end')

:@Err#Usr0000055

Português (Brasil)

Foi alcançado o limite de velocidade de consumo do saldo do usuário

:@Err#Usr0000058

Português (Brasil)

A chamada do método implica na tentativa de debitar um usuário inexistente

US Patent Requested