Refund all invoices of a Qattah Pay Order

Refund all invoices of a Qattah Pay Order request is sent through an HTTPS API accepting the order ID as a path parameter

The "Refund All Invoices" endpoint is a REST API that allows clients to request a refund for all invoices of a specific order that has been fully paid. The endpoint works by passing the order ID in the path parameter, which will then request our server to refund the total amount paid to the end users.

API call

POST https://staging-api.qattahpay.sa/api/v1/merchant-integration/orders/{order_id}/refund

api_token is provided by QattahPay for each integration

Headers

Name	Type	Description
Content-Type*	String	header must be set to application/json
Accept*	String	header must be set to application/json
Authorization*	String	header must be the api_token

200 The request had been properly processed

{
    "successful": true
}

401 Unauthorized

Rate limit: The rate limit is set to prevent malicious behaviour and poor user experiences. The per-hour rate limit per channel token is 20000 requests. You can contact your QattahPay representative if a higher limit is necessary.