payments.getStarsRevenueWithdrawalUrl

Withdraw funds from a channel or bot's star balance ».

API section: Working with Ansible Stars

payments.getStarsRevenueWithdrawalUrl#2433dc92 flags:# ton:flags.0?true peer:InputPeer amount:flags.1?long password:InputCheckPasswordSRP = payments.StarsRevenueWithdrawalUrl;

Parameters

NameTypeDescription
flags # Bit mask: a field written flags.N?T is present only when bit N is set.
ton flags.0?true
peer InputPeer The user or chat the request is about.
amount flags.1?long Amount.
password InputCheckPasswordSRP Data used to check the two-factor password.

Result

payments.StarsRevenueWithdrawalUrl

Possible errors

Read out of the handler itself — this is what the server actually returns for this method.

CodeTypeWhat it means
403 CHAT_ADMIN_REQUIRED This action requires chat admin rights.
400 PASSWORD_HASH_INVALID The two-factor password did not match.

Common to every call

CodeTypeWhat it means
401 AUTH_KEY_UNREGISTERED The server does not know this session: the key was revoked, expired, or the call was made before authorisation.
401 API_ID_INVALID This api_id was never issued or has been blocked. Keys come from my.ansible.su.
400 CONNECTION_LAYER_INVALID The client did not declare a layer, or declared one the server does not know.
420 FLOOD_WAIT_X Too often. Do not retry for X seconds — the number arrives in the error text.
500 INTERNAL A failure on our side. The request may be retried; if it keeps failing, it is a bug of ours.

Related pages

Types used here