Payment Agent: Transfer (paymentagent_transfer)

Payment Agent Transfer - this call is available only to accounts that are approved Payment Agents.

Auth Scope(s): payments

paymentagent_transfer(amount: Union[int, float, Decimal], currency: str, transfer_to: 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 transfer.
  • currency (str) – Currency code.
  • transfer_to (str) – The loginid of the recipient account.
  • description (Optional[str]) – [Optional] Remarks about the transfer.
  • 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_transfer(
    amount=1000
    currency='USD'
    transfer_to='CR100001'
)

See also