P2P Order Create (p2p_order_create)¶

Creates a P2P order for the specified advert.

Auth Scope(s): payments

p2p_order_create(advert_id: str, amount: Union[int, float, Decimal], contact_info: Optional[str] = None, payment_info: Optional[str] = None, payment_method_ids: Optional[List] = None, rate: Optional[Union[int, float, Decimal]] = None, subscribe: Optional[Union[bool, int]] = None, passthrough: Optional[Any] = None, req_id: Optional[int] = None) → int¶

Parameters:	advert_id (str) – The unique identifier for the advert to create an order against. amount (Union[int, float, Decimal]) – The amount of currency to be bought or sold. contact_info (Optional[str]) – [Optional] Seller contact information. Only applicable for ‘sell orders’. payment_info (Optional[str]) – [Optional] Payment instructions, only applicable for sell orders. payment_method_ids (Optional[List]) – IDs of payment methods, only applicable for sell orders. rate (Optional[Union[int, float, Decimal]]) – [Optional] Conversion rate from account currency to local currency, only applicable for floating rate adverts. subscribe (Optional[Union[bool, int]]) – [Optional] If set to 1, will send updates whenever there is an update to the order. 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.p2p_order_create(
    advert_id='1234'
    amount=100
)