Skip to content

Latest commit

 

History

History
36 lines (23 loc) · 1.34 KB

paymentagent_list.rst

File metadata and controls

36 lines (23 loc) · 1.34 KB
Raw

Payment Agent: List (paymentagent_list)

Will return a list of Payment Agents for a given country for a given currency. Payment agents allow users to deposit and withdraw funds using local payment methods that might not be available via the main website's cashier system.

.. py:method:: paymentagent_list(paymentagent_list: str, currency: Optional[str] = None, passthrough: Optional[Any] = None, req_id: Optional[int] = None) -> int

   :param paymentagent_list: Client's 2-letter country code (obtained from `residence_list` call).
   :type paymentagent_list: str
   :param currency: [Optional] If specified, only payment agents that supports that currency will be returned (obtained from `payout_currencies` call).
   :type currency: Optional[str]
   :param passthrough: [Optional] Used to pass data through the websocket, which may be retrieved via the `echo_req` output field.
   :type passthrough: Optional[Any]
   :param req_id: [Optional] Used to map request to response.
   :type req_id: Optional[int]
   :returns: req_id
   :rtype: int

Example

binary.api.paymentagent_list(
    'id'
)
.. seealso::
   * `Binary API Docs for paymentagent_list <https://developers.binary.com/api/#paymentagent_list>`_