Cancel Order

post

https://api.staging.madfu.com.sa/Merchants/Order/CancelOrder_OnlinePayment

The Order Cancellation API allows merchants to cancel an order before receiving payment from the customer. This enables merchants to halt the processing of an order using either the invoice code or merchant reference. At least one of two parameters should be provided: either orderId or merchantReference.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

invoiceCode

string

Your provided Invoice Code while creating the order.

merchantReference

string

Your reference order number that you sent to MADFU while creating the order.

Headers

Token

string

required

JWT Token that generated from /merchants/token/sign-in API without 'Bearer ' keyword.

APIKey

string

required

Your API Key. This key is required for authentication and authorization purposes.

AppCode

string

required

Your App Code. This code identifies your application to the server.

PlatformTypeId

string

required

Platform TypeId. This ID indicates the type of platform you are using.

Authorization

string

required

Authorization. This token grants access to protected resources.

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200While the 200 OK HTTP status code is common, it doesn't solely indicate success in this API. Clients must check the 'statusCode' property in the response body to confirm the operation's success or failure accurately.

401indicates that the request has not been applied because it lacks valid authentication credentials for the target resource.

500This indicates unexpected server errors or, at times, errors resulting from invalid user inputs.