POST /v1/refund-requests
CheckoutService_RequestRefund
The server validates credentials, tenant, environment and permissions. This page does not send requests. Replace example values; deployed server validation remains authoritative.
Parameters
No path or query parameters.
Request body
amountstringidempotency_keystringitemsarrayExpand fields
order_line_idstringquantitystring
modestringorder_idstringpreview_tokenstringreasonstring
cURL
curl --request POST 'https://nexus-api.rainlib.com/v1/refund-requests' \
--header 'Authorization: Bearer <NEXUS_ACCESS_TOKEN>' \
--header 'Content-Type: application/json' \
--data '{
"order_id": "<order-id>",
"mode": "RETURN_ITEMS",
"items": [
{
"order_line_id": "<order-line-id>",
"quantity": "1"
}
],
"reason": "<customer-reason>",
"preview_token": "<preview.preview_token>",
"idempotency_key": "<refund-request-key>"
}'Response contract
200 · OK
amountstringcreated_atstringcurrencystringcustomer_account_idstringeffects_statusstringexecution_statusstringidstringmodestringorder_idstringpolicy_versionstringreasonstringrecovery_statestringrefund_idstringrequested_bystringreview_reasonstringreviewed_bystringstatusstringupdated_atstringversionstring
Generated responses do not enumerate every runtime error. See the integration guide for authentication, conflicts and retries.