P2P Advert Update (p2p_advert_update)

Updates a P2P advert. Can only be used by the advertiser.

Auth Scope(s): payments

p2p_advert_update(id: str, contact_info: Optional[str] = None, delete: Optional[int] = None, description: Optional[str] = None, is_active: Optional[int] = None, local_currency: Optional[str] = None, max_order_amount: Optional[Union[int, float, Decimal]] = None, min_order_amount: Optional[Union[int, float, Decimal]] = None, payment_info: Optional[str] = None, payment_method_ids: Optional[List] = None, payment_method_names: Optional[List] = None, rate: Optional[Union[int, float, Decimal]] = None, rate_type: Optional[str] = None, remaining_amount: Optional[Union[int, float, Decimal]] = None, passthrough: Optional[Any] = None, req_id: Optional[int] = None) → int
Parameters:
  • id (str) – The unique identifier for this advert.
  • contact_info (Optional[str]) – [Optional] Advertiser contact information.
  • delete (Optional[int]) – [Optional] If set to 1, permanently deletes the advert.
  • description (Optional[str]) – [Optional] General information about the advert.
  • is_active (Optional[int]) – [Optional] Activate or deactivate the advert.
  • local_currency (Optional[str]) – [Optional] Local currency for this advert.
  • max_order_amount (Optional[Union[int, float, Decimal]]) – [Optional] Maximum allowed amount for the orders of this advert, in advertiser’s account_currency. Should be more than or equal to min_order_amount.
  • min_order_amount (Optional[Union[int, float, Decimal]]) – [Optional] Minimum allowed amount for the orders of this advert, in advertiser’s account_currency. Should be less than or equal to max_order_amount.
  • payment_info (Optional[str]) – [Optional] Payment instructions.
  • payment_method_ids (Optional[List]) – [Optional] IDs of previously saved payment methods as returned from p2p_advertiser_payment_methods, only applicable for sell ads. Exisiting methods will be replaced.
  • payment_method_names (Optional[List]) – [Optional] Payment method identifiers as returned from p2p_payment_methods, only applicable for buy ads. Exisiting methods will be replaced.
  • rate (Optional[Union[int, float, Decimal]]) – [Optional] Conversion rate from advertiser’s account currency to local_currency. An absolute rate value (fixed), or percentage offset from current market rate (floating).
  • rate_type (Optional[str]) – [Optional] Type of rate, fixed or floating.
  • remaining_amount (Optional[Union[int, float, Decimal]]) – [Optional] The total available amount of the advert, in advertiser’s account currency.
  • 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_advert_update(
    id=1234
    is_active=0
)

See also