{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/orders/:order_id/refunds","auth":"required","settings":"5adcc50db719b20003516400","results":{"codes":[{"name":"","code":"{\n  \"current_page\": 1,\n  \"per_page\": 100,\n  \"total_refunds\": 2,\n  \"total_pages\": 1,\n  \"refunds\": [\n    {\n      \"id\": 2,\n      \"request_amount\": \"50.0\",\n      \"refund_amount\": \"0.0012965\",\n      \"crypto_address\": \"tb1qparagdh9h884lptjmlt20ugc05xrvhu32qa05z6\",\n      \"crypto_address_memo\": null,\n      \"status\": \"pending\",\n      \"order\": {\n        \"id\": 83\n      },\n      \"refund_currency\": {\n        \"id\": 1,\n        \"title\": \"Bitcoin\",\n        \"symbol\": \"BTC\",\n        \"platform\": {\n          \"id\": 5,\n          \"title\": \"Bitcoin\"\n        }\n      }\n    },\n    {\n      \"id\": 1,\n      \"request_amount\": \"50.0\",\n      \"refund_amount\": \"0.0012965\",\n      \"crypto_address\": \"tb1qparagdh9h884lptjmlt20ugc05xrvhu32qa05z6\",\n      \"crypto_address_memo\": null,\n      \"status\": \"pending\",\n      \"order\": {\n        \"id\": 83\n      },\n      \"refund_currency\": {\n        \"id\": 1,\n        \"title\": \"Bitcoin\",\n        \"symbol\": \"BTC\",\n        \"platform\": {\n          \"id\": 5,\n          \"title\": \"Bitcoin\"\n        }\n      }\n    }\n  ]\n}","language":"json","status":200},{"name":"","code":"{\n  \"message\": \"Order not found\",\n  \"reason\": \"OrderNotFound\"\n}","language":"json","status":404}]},"params":[{"name":"order_id","type":"int","default":"","desc":"ID of the order to be refunded","required":true,"in":"path","ref":"","_id":"623d9e834899ce03ac920f21"},{"name":"page","type":"int","default":"1","desc":"Current page number","required":false,"in":"body","ref":"","_id":"627a729ea43831003e0ee61d"},{"name":"per_page","type":"int","default":"100","desc":"Number of refunds per page","required":false,"in":"body","ref":"","_id":"627a729ea43831003e0ee61e"}],"examples":{"codes":[]},"method":"get"},"next":{"description":"","pages":[]},"title":"Get Order Refunds","type":"endpoint","slug":"get-refund","excerpt":"Retrieves all refunds for an order.\n\nBefore making a <b>GET Order Refunds</b> request, a [POST Create Order](doc:create-order) request should be made. \n\nAfter an order is created, you will get the order ID which will be used in the <b>GET Order Refunds</b> request.","body":"","updates":[],"order":2,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"6239b3bd710cc300612f631f","createdAt":"2022-03-22T11:32:13.447Z","user":"5530bf7457cea10d00a3aa3a","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Refunds","slug":"refunds","order":3,"from_sync":false,"reference":false,"_id":"627511250a8fbb052a794d80","createdAt":"2022-05-06T12:14:29.357Z","version":"5adcc1185cd1890003da8165","project":"5530bfac57cea10d00a3aa3b","__v":0},"version":{"version":"2","version_clean":"2.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["5adcc1185cd1890003da8166","5adcc1185cd1890003da8167","5adcf4b3ce4b3f00035317e9","5adfb8e9452bd900036d115b","5e7b51281ac49702d745882c","5e7b526560c6cc004f25ca3e","61c47c8dc69d6b000f961812","62289a8cb831c9003650b36c","62615ded4828c0003015b8a2","627511250a8fbb052a794d80","62b43cee767dd2003ad59e14"],"_id":"5adcc1185cd1890003da8165","project":"5530bfac57cea10d00a3aa3b","createdAt":"2018-04-22T17:06:32.152Z","releaseDate":"2018-04-22T17:06:32.152Z","__v":10},"project":"5530bfac57cea10d00a3aa3b","__v":26,"parentDoc":null}

getGet Order Refunds

Retrieves all refunds for an order. Before making a <b>GET Order Refunds</b> request, a [POST Create Order](doc:create-order) request should be made. After an order is created, you will get the order ID which will be used in the <b>GET Order Refunds</b> request.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

order_id:
required
integer
ID of the order to be refunded

Body Params

page:
integer1
Current page number
per_page:
integer100
Number of refunds per page

Result Format