BIbity
Orders

Cancel an order

Attempt to cancel an order.

If a payment is received after the order has been cancelled, Bity is free to choose what to do at its own discretion. Bity will generally attempt to perform a refund to the same crypto-address or IBAN having performed the payment. Various unpredictable fees may apply. It is very highly recommended to not cancel orders for which a payment has already been sent.

This functionality is meant for the customer to cancel orders for which no payment has been made and will be made. In particular, it is not meant to cancel orders for which a payment has already been made or will be made at a later time, and will result in an unpredictable outcome if used in such situation.

post/orders/{order_uuid}/cancel

Request

  • Base URL
    https://exchange.api.bity.com/v2
  • Auth
    • none
    • or OAuth 2
      Authorization codehttps://connect.bity.com/oauth2/auth
      Token URLhttps://connect.bity.com/oauth2/token
      Scopeshttps://auth.bity.com/scopes/exchange.place
    • or OAuth 2
      Client credentials
      Token URLhttps://connect.bity.com/oauth2/token
      Scopeshttps://auth.bity.com/scopes/exchange.place
    • or OAuth 2
      Client credentials
      Token URLhttps://connect.bity.com/oauth2/token
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Path parameters

order_uuidstring required

Identifier of the order to attempt to cancel

Response

The request to cancel the order is being processed asynchronously.

It is at this time not possible to know whether the cancellation attempt will be successful or not.

Changes

No recorded changes to this operation across all 1 revision of this API.