orders

Cancel Order

The Cancel Order is an authenticated API that allows users to cancel an existing order before payment is completed. This API is useful for cases where users change their mind, enter incorrect details, or experience payment issues. Once an order is successfully canceled, it cannot be reversed, and a new order must be placed.

delete/api/v2/orders/{orderid}

Request

  • Base URL: https://api-gateway-stg.transak.com
  • URL: https://api-gateway-stg.transak.com/api/v2/orders/{orderid}
  • Auth: none declared. Required headers: x-user-ip, x-api-key

Path parameters

orderidstring required

orderId is the id received from the API - api/v2/orders

Query parameters

cancelReasonstring required

Reason to Cancel the order

Headers

x-user-ipstring required

End user's originating IP. More details here

x-api-keystring required

Partner API Key present in Transak Dashboard.

authorizationstring

Authorization token is the accessToken received from the API - api/v2/auth/verify

Note: This is not applicable for Auth Reliance Flows

x-user-identifierstring

Your authenticated user Email Id address.

Note: This is applicable only for Auth Reliance Flows

x-access-tokenstring

Your Partner Access Token. Please refer here for a tutorial on generating your access token.

Note: This is applicable only for Auth Reliance Flows

Response

200 - Success

Changes

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