[POST] Create refund requests
Request Description
POST /v1/order/[order id]/refundIt allows you to create refund requests.
You can create a refund request if an payment meets the following conditions:
Payment status is paid
Payment amount is greater than zero
No other refund requests having status New or Processing exist for the payment
Once a request has been created, it is processed individually on our end. If a refund is made as the result of processing, you receive a webhook on the event (if connected). You can check request statuses using the ESupport portal.
This request can also be used to make refund/return requests for orders created via Noventiq Checkout.
Connection Data
Endpoint URL:
Production environment: https://api.ecommerce.noventiq.com/v1/order/[order id]/refund
Test environment: https://api.ecommerce.noventiq.com.demonqweb.com/v1/order/[order id]/refund
Request Method: POST
Format: JSON
Authorization: token-based
URL Parameters
[order id]
required
Order identifier
You can get it from:
Response to the request used for creating payment object (order_id) or auto-payment processing (order_id)
Webhook (order_id)
Response to the request used for getting lists of IDs of orders (ids)
Example: /v1/order/123456/refund
Header Parameters
content-type
string
required
MIME-type
It must be equal to "application/json".
AuthorizationJWT
required
Authorization token.
Format:
Bearer [token]Replace [token] with the token value, you get in response to the request sent to the Authentication API
Body Parameters
description
string
Refund reason description
Must not exceed 500 characters. UTF is supported.
string
required
Your email for questions on refund
Note that this is not your end customer's email. We will contact you using this email if we have any questions during refund processing. The request processing results will not be duplicated to this email.
Must not exceed 80 characters.
Request Example
{
"description": "Test order",
"email": "merchant@gmail.com"
}Response Description
In response to the request, you receive the server response code corresponding to the processing result. Depending on the code, the response body may contain additional parameters.
Successful Response
If processing is successful, the following will return in response server response code: HTTP/1.1 200 OК
Error Response
If an error occurs while processing the request, you receive a server response code corresponding to the result of processing.
Depending on the code, the response body may contain additional parameters.
HTTP Server Response Error Code
HTTP code | Description |
HTTP/1.1 400 Bad Request | The request is not valid (error in parameters; necessary data is not transferred, etc.). |
HTTP/1.1 401 Unauthorized | Unsuccessful authorization. |
HTTP/1.1 404 Not found | Invalid request URL or no payment having the identifier transferred is found. If no payment is found, an additional additional error code will return in the response body. |
HTTP/1.1 500 Request Error | Internal Server Error. Please try again later or contact support. |
Additional Error Codes for HTTP 400
Error | Message | Description |
If at least one error from the list below is found, then it returns in response to a request, other errors are not validated. | ||
110 | JSON is not valid. | The request cannot be processed. Request field structure is not valid. Check the fields in the request body against the JSON format. |
111 | Invalid data format (Content-type). | The request cannot be processed. Invalid request header. Content-type must be equal to application/json. |
15000 | Unable to identify your configuration for accessing this API. Please contact technical support. | During processing, we could not identify your account setting unambiguously. Please contact support team. |
15030 | Order refund is impossible. Order status is not equal to "paid". | The system cannot accept the refund request. The status of the payment object is not paid. |
15040 | Order refund is impossible. Order price amount is equal to zero. | The system cannot accept the refund request. The amount of the payment is zero. |
15050 | Order refund is impossible. Order refund request already exists. | The system cannot accept the refund request. A refund request having status New/Processing already exists for the payment. |
If at least one error from the list below is found, then request validation is not interrupted. Several errors may return in response. | ||
15010 | Invalid field value: [parametr name] | The request is not valid, e.g., the required parameter is not filled out, the parameter name is incorrect, the parameter value does not match with the data type provided, or the value format is incorrect. Moreover, the error will return if null is transferred in the parameter, and this value option is not set as valid in the parameter description. |
Additional Error Codes for HTTP 401
The errors are the same for all the APIs that use token authorization.
Additional Error Codes for HTTP 404
Error | Message | Description |
15060 | Order refund is impossible. Order not found. | No payment with the identifier transferred is found, or you do not have the rights to get the data. |
Body Parameters
errors
array [objects]
required
Error list
errors / [error object] / error
number
required
Error code
errors / [error object] / message
string
Error description
Example of Error Response
{
"errors": [{
"error": 15020,
"message": "Order not found."
}
]
}Noventiq Payments
Support |