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.

paymentagent_list(paymentagent_list: str, currency: Optional[str] = None, passthrough: Optional[Any] = None, req_id: Optional[int] = None) → int
Parameters:
  • paymentagent_list (str) – Client’s 2-letter country code (obtained from residence_list call).
  • currency (Optional[str]) – [Optional] If specified, only payment agents that supports that currency will be returned (obtained from payout_currencies call).
  • 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_list(
    'id'
)

See also