Cashier Information (cashier)¶

Request the cashier info for the specified type.

Auth Scope(s): payments

cashier(cashier: str, address: Optional[str] = None, amount: Optional[Union[int, float, Decimal]] = None, dry_run: Optional[int] = None, provider: Optional[str] = None, type: Optional[str] = None, verification_code: Optional[str] = None, passthrough: Optional[Any] = None, req_id: Optional[int] = None) → int¶

Parameters:	cashier (str) – Operation which needs to be requested from cashier address (Optional[str]) – [Optional] Address for crypto withdrawal. Only applicable for api type. amount (Optional[Union[int, float, Decimal]]) – [Optional] Amount for crypto withdrawal. Only applicable for api type. dry_run (Optional[int]) – [Optional] If set to 1, only validation is performed. Only applicable for withdraw using crypto provider and api type. provider (Optional[str]) – [Optional] Cashier provider. crypto will be default option for crypto currency accounts. type (Optional[str]) – [Optional] Data need to be returned from cashier. api is supported only for crypto provider. verification_code (Optional[str]) – [Optional] Email verification code (received from a verify_email call, which must be done first) passthrough (Optional[Any]) – [Optional] Used to pass data through the websocket, which may be retrieved via the echo_req output field. req_id (Optional[int]) – [Optional] Used to map request to response.
Returns:	req_id
Return type:	int

Example¶

binary.api.cashier(
    'deposit'
    provider='doughflow'
    verification_code='my_verification_code'
)