Payment Agent: Withdraw (paymentagent_withdraw)

Initiate a withdrawal to an approved Payment Agent.

Auth Scope(s): payments

paymentagent_withdraw(amount: Union[int, float, Decimal], currency: str, paymentagent_loginid: str, verification_code: str, description: Optional[str] = None, dry_run: Optional[int] = None, passthrough: Optional[Any] = None, req_id: Optional[int] = None) → int
Parameters:
  • amount (Union[int, float, Decimal]) – The amount to withdraw to the payment agent.
  • currency (str) – The currency code.
  • paymentagent_loginid (str) – The payment agent loginid received from the paymentagent_list call.
  • verification_code (str) – Email verification code (received from a verify_email call, which must be done first)
  • description (Optional[str]) – [Optional] Remarks about the withdraw. Only letters, numbers, space, period, comma, - ‘ are allowed.
  • dry_run (Optional[int]) – [Optional] If set to 1, just do validation.
  • 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.paymentagent_withdraw(
    amount=1000
    currency='USD'
    paymentagent_loginid='CR100001'
    verification_code='my_verification_code'
)

See also