REFUND Order

to refund an order, post with the order id, payment method, ids, and refund amounts with your private key from your server you have 2 options (listed below) when processing refunds refund order simply provide the refund amount if the refund amount is less than the total order amount and there are more than 1 payment method, we'll use the store configurations to determine which payment method to refund first refund order by individual payment methods specify the refund amount per payment method { "tab" "examples", "url" "https //test api featherpay io/api/v1/orders/{orderid}/refundbyorder", "name" "refund order", "method" "post", "request" { "pathparameters" \[], "queryparameters" \[], "headerparameters" \[], "bodydataparameters" \[], "formdataparameters" \[] }, "results" { "languages" \[ { "id" "hjzesnc macjawn5 nhc1", "code" "{\n \\"success\\"\ true,\n \\"orderid\\" \\"01fyxzbez19yjvvhks32hy6a3r\\",\n \\"paymentrefunds\\" \[\n {\n \\"orderpaymentid\\" \\"01fyxzrhr78zarn6nzcz8m7re2\\",\n \\"refundamount\\" 1000\n }\n ],\n \\"paymentresponses\\" \[\n {\n \\"message\\" \\"this transaction has been refunded \\",\n \\"paymenttype\\" \\"manual\\",\n \\"paymentid\\" \\"01fyxzrhr78zarn6nzcz8m7re2\\",\n \\"statuscode\\" 200,\n \\"success\\"\ true\n }\n ]\n}", "language" "200", "customlabel" "" } ], "selectedlanguageid" "hjzesnc macjawn5 nhc1" }, "examples" { "languages" \[ { "id" "ueoyuidh4dgvqc ubfyov", "code" "curl x post \\\\\n url 'https //test api featherpay io/api/v1/orders/\ orderid/refundbyorder' \\\\\n header 'content type application/json;charset=utf 8' \\\\\n header 'accept application/json' \\\\\n header 'x api key {secret api key}' \\\\\n header 'x store id {store ulid}' \\\\\n data '{\n \\"refundamount\\" 1000\n}'", "language" "curl", "customlabel" "" } ], "selectedlanguageid" "ueoyuidh4dgvqc ubfyov" }, "description" "simple refund of order only specifying the amount to be refunded", "currentnewparameter" { "label" "body parameter", "value" "bodydataparameters" } } { "tab" "examples", "url" "https //test api featherpay io/api/v1/orders/{orderid}/refund", "name" "refund order by individual payment methods", "method" "post", "request" { "pathparameters" \[], "queryparameters" \[], "headerparameters" \[], "bodydataparameters" \[], "formdataparameters" \[] }, "results" { "languages" \[ { "id" "h1ooflv5gkl2ewmfai sx", "code" "\[\n {\n \\"message\\" \\"this transaction has been approved \\",\n \\"paymenttype\\" \\"credit / debit card\\",\n \\"paymentid\\" \\"01ey8xrzzz7jpyqwzfanx0n5cm\\",\n \\"statuscode\\" 200\n },\n {\n \\"message\\" \\"this transaction has been approved \\",\n \\"paymenttype\\" \\"credit / debit card\\",\n \\"paymentid\\" \\"01ey8zsztv1kk7xzbka2h0tjsn\\",\n \\"statuscode\\" 200\n }\n]", "language" "200", "customlabel" "" } ], "selectedlanguageid" "h1ooflv5gkl2ewmfai sx" }, "examples" { "languages" \[ { "id" "ymorlkphj zwiepmw 1ca", "code" "curl x post \\\\\n url 'https //test api featherpay io/api/v1/orders/\ orderid/refund' \\\\\n header 'accept application/json' \\\\\n header 'x api key {secret api key}' \\\\\n header 'x store id {store ulid}' \\\\\n data '\[\n {\n \\"orderpaymentid\\" \\"01ey8xrzzz7jpyqwzfanx0n5cm\\",\n \\"refundamount\\" 100000\n },\n {\n \\"orderpaymentid\\" \\"01ey8zsztv1kk7xzbka2h0tjsn\\",\n \\"refundamount\\" 400000\n }\n ]'", "language" "curl", "customlabel" "" } ], "selectedlanguageid" "ymorlkphj zwiepmw 1ca" }, "description" "refund an order by specifying the refund amount per order payment", "currentnewparameter" { "label" "body parameter", "value" "bodydataparameters" } }