Payment agent create (paymentagent_create)¶

Saves client’s payment agent details.

Auth Scope(s): admin

paymentagent_create(code_of_conduct_approval: int, commission_deposit: Union[int, float, Decimal], commission_withdrawal: Union[int, float, Decimal], email: str, information: str, payment_agent_name: str, supported_payment_methods: List, urls: List, affiliate_id: Optional[str] = None, phone_numbers: Optional[List] = None, passthrough: Optional[Any] = None, req_id: Optional[int] = None) → int¶

Parameters:	code_of_conduct_approval (int) – Indicates client’s agreement with the Code of Conduct. commission_deposit (Union[int, float, Decimal]) – Commission (%) the agent wants to take on deposits commission_withdrawal (Union[int, float, Decimal]) – Commission (%) the agent wants to take on withdrawals email (str) – Payment agent’s email address. information (str) – [Optional] Information about payment agent and their proposed service. payment_agent_name (str) – The name with which the payment agent is going to be identified. supported_payment_methods (List) – A list of supported payment methods. urls (List) – The URL(s) of payment agent’s website(s). affiliate_id (Optional[str]) – [Optional] Client’s My Affiliate id, if exists. phone_numbers (Optional[List]) – Payment agent’s phone number(s) with country code. 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_create(
    affiliate_id='1231234'
    code_of_conduct_approval=1
    commission_deposit=2
    commission_withdrawal=3
    email='joe@joy.com'
    information='The best person you can find'
    payment_agent_name='Joe Joy'
    phone_numbers=[{'phone_number': '+923-22-23-13'}]
    supported_payment_methods=[{'payment_method': 'MasterCard'}, {'payment_method': 'Visa'}]
    urls=[{'url': 'https://abc.com'}]
)