{"_id":"59e1298761e0e70010086457","project":"556cd8aec14029190092d292","version":{"_id":"556cd8aec14029190092d295","__v":14,"project":"556cd8aec14029190092d292","createdAt":"2015-06-01T22:11:58.756Z","releaseDate":"2015-06-01T22:11:58.756Z","categories":["556cd8afc14029190092d296","55ca5a55241e790d004f47ea","55dc9fdb4f535537007da1b2","55dc9fdfc755b63700dc843c","55fdb08c4bebdf17004130d4","560ef4c2a36c610d00e7013e","5613db296a092921004c30c2","56156581dc8aea0d002475e8","56169d1ee98f5517005627a8","5622fde7de7dc01700c6dd5f","56cf75f3336aa60b0086a495","5818f3c02093901b00bcf91a","582f7ff88ea0800f0035639a","583f30c110448a2500dd990f"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"category":{"_id":"55fdb08c4bebdf17004130d4","project":"556cd8aec14029190092d292","version":"556cd8aec14029190092d295","__v":11,"pages":["55fdb124b652110d00758b70","55fdb2a956d6990d00a6caca","55fdb38856d6990d00a6cacc","55ff6c519e7ccf0d000a1d7f","5613db97acd4343500088079","5616d7b9cf2a1e0d00247971","56196204fa2a6d0d002a1352","5622f2c906481c0d00e5315c","569526b8caa32519009c411e","569fbbcbbeb79a17009f8f89","56aac68aac665d0d00af76b0"],"sync":{"url":"","isSync":false},"reference":true,"createdAt":"2015-09-19T18:59:24.105Z","from_sync":false,"order":4,"slug":"how-to","title":"How To..."},"user":"56264a84d0f87e190014c56b","__v":0,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-10-13T21:00:55.990Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":true,"order":999,"body":"[block:api-header]\n{\n  \"title\": \"Refund Request Lifecycle\"\n}\n[/block]\nAfter an order has been placed, the buyer may initiate a refund, which creates a refund request in a `pending_seller_response` state.\n\nThe seller may respond via Reverb's API by updating the refund request with one of the following states:\n\n- `conditionally_approved`: Approve the refund after the item has been returned. The refund request is still active and will need to be approved at a later time.\n- `approved`: Approve the refund immediately, typically after the item has been returned. This will immediately credit the buyer and debit the seller. Once approved, the refund request is completed and no further action is needed.\n- `denied`: Deny the refund, which will complete the refund request without crediting the buyer or debiting the seller. Once denied, the refund request is completed and no further action is needed.\n\nWhen responding to a refund request by approving or conditionally approving, the seller may also change the amount to be refunded.\n\nA single order can have multiple refund requests, as long as the order has not been fully refunded.\n[block:api-header]\n{\n  \"title\": \"Getting a List of Refund Requests\"\n}\n[/block]\nBy default, refund requests with an active state (`pending_seller_response` or `conditionally_approved`) are returned. These can be filtered by created date range or updated date range:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl \\\\\\n-XGET \\\\\\n-H \\\"Authorization: Bearer [oauth_token]\\\" \\\\\\n-H \\\"Content-Type: application/hal+json\\\" \\\\\\n-H \\\"Accept-Version: 3.0\\\" \\\\\\nhttps://api.reverb.com/api/my/refund_requests?created_start_date=2017-10-01T12:00-00:00&created_end_date=2017-10-31T12:00-00:00\",\n      \"language\": \"curl\"\n    }\n  ]\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl \\\\\\n-XGET \\\\\\n-H \\\"Authorization: Bearer [oauth_token]\\\" \\\\\\n-H \\\"Content-Type: application/hal+json\\\" \\\\\\n-H \\\"Accept-Version: 3.0\\\" \\\\\\nhttps://api.reverb.com/api/my/refund_requests?updated_start_date=2017-10-01T12:00-00:00&updated_end_date=2017-10-31T12:00-00:00\",\n      \"language\": \"curl\"\n    }\n  ]\n}\n[/block]\nRefund requests can also be filtered to an individual state, a list of states, and paginated through:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl \\\\\\n-XGET \\\\\\n-H \\\"Authorization: Bearer [oauth_token]\\\" \\\\\\n-H \\\"Content-Type: application/hal+json\\\" \\\\\\n-H \\\"Accept-Version: 3.0\\\" \\\\\\nhttps://api.reverb.com/api/my/refund_requests?state=approved\",\n      \"language\": \"curl\",\n      \"name\": null\n    }\n  ]\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl \\\\\\n-XGET \\\\\\n-H \\\"Authorization: Bearer [oauth_token]\\\" \\\\\\n-H \\\"Content-Type: application/hal+json\\\" \\\\\\n-H \\\"Accept-Version: 3.0\\\" \\\\\\n'https://api.reverb.com/api/my/refund_requests?state[]=approved&state[]=conditionally_approved'\",\n      \"language\": \"curl\"\n    }\n  ]\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl \\\\\\n-XGET \\\\\\n-H \\\"Authorization: Bearer [oauth_token]\\\" \\\\\\n-H \\\"Content-Type: application/hal+json\\\" \\\\\\n-H \\\"Accept-Version: 3.0\\\" \\\\\\nhttps://api.reverb.com/api/my/refund_requests?page=1&per_page=1\",\n      \"language\": \"curl\"\n    }\n  ]\n}\n[/block]\nThe response format includes a list of refund requests and its associated order:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{  \\n   \\\"total\\\":2,\\n   \\\"current_page\\\":1,\\n   \\\"per_page\\\":1,\\n   \\\"total_pages\\\":2,\\n   \\\"_links\\\":{  \\n      \\\"next\\\":{  \\n         \\\"href\\\":\\\"https://api.reverb.com/api/my/refund_requests/selling?page=2&per_page=1&state=conditionally_approved\\\"\\n      }\\n   },\\n   \\\"refund_requests\\\":[  \\n      {  \\n         \\\"id\\\":47,\\n         \\\"state\\\":\\\"conditionally_approved\\\",\\n         \\\"amount\\\":{  \\n            \\\"amount\\\":\\\"87.00\\\",\\n            \\\"amount_cents\\\":8700,\\n            \\\"currency\\\":\\\"USD\\\",\\n            \\\"symbol\\\":\\\"$\\\",\\n            \\\"display\\\":\\\"$87\\\"\\n         },\\n         \\\"refund_type\\\":\\\"full\\\",\\n         \\\"reason\\\":\\\"buyer_return\\\",\\n         \\\"initiated_by\\\":\\\"buyer\\\",\\n         \\\"note_to_buyer\\\":\\\"\\\",\\n         \\\"created_at\\\":\\\"2017-05-12T09:56:03-05:00\\\",\\n         \\\"updated_at\\\":\\\"2017-05-12T09:56:03-05:00\\\",\\n         \\\"order\\\":{  \\n            \\\"buyer_id\\\":\\\"1651\\\",\\n            \\\"order_number\\\":\\\"290\\\",\\n            \\\"paid_at\\\":\\\"2017-05-12T09:54:25-05:00\\\",\\n            \\\"quantity\\\":1,\\n            \\\"shipping_address\\\":{  \\n               \\\"region\\\":\\\"IL\\\",\\n               \\\"locality\\\":\\\"Chicago\\\",\\n               \\\"country_code\\\":\\\"US\\\",\\n               \\\"display_location\\\":\\\"Chicago, IL, United States\\\"\\n            },\\n            \\\"shipping_date\\\":\\\"2017-05-12\\\",\\n            \\\"shipped_at\\\":\\\"2017-05-12T09:55:15-05:00\\\",\\n            \\\"shipping_provider\\\":\\\"USPS\\\",\\n            \\\"shipping_code\\\":\\\"9410836897846109604096\\\",\\n            \\\"shipping_method\\\":\\\"shipped\\\",\\n            \\\"local_pickup\\\":false,\\n            \\\"status\\\":\\\"shipped\\\",\\n            \\\"product_id\\\":\\\"637\\\",\\n            \\\"order_bundle_id\\\":\\\"162\\\",\\n            \\\"created_at\\\":\\\"2017-05-12T09:54:23-05:00\\\",\\n            \\\"amount_product\\\":{  \\n               \\\"amount\\\":\\\"77.00\\\",\\n               \\\"amount_cents\\\":7700,\\n               \\\"currency\\\":\\\"USD\\\",\\n               \\\"symbol\\\":\\\"$\\\",\\n               \\\"display\\\":\\\"$77\\\"\\n            },\\n            \\\"amount_product_subtotal\\\":{  \\n               \\\"amount\\\":\\\"77.00\\\",\\n               \\\"amount_cents\\\":7700,\\n               \\\"currency\\\":\\\"USD\\\",\\n               \\\"symbol\\\":\\\"$\\\",\\n               \\\"display\\\":\\\"$77\\\"\\n            },\\n            \\\"shipping\\\":{  \\n               \\\"amount\\\":\\\"10.00\\\",\\n               \\\"amount_cents\\\":1000,\\n               \\\"currency\\\":\\\"USD\\\",\\n               \\\"symbol\\\":\\\"$\\\",\\n               \\\"display\\\":\\\"$10\\\"\\n            },\\n            \\\"amount_tax\\\":{  \\n               \\\"amount\\\":\\\"0.00\\\",\\n               \\\"amount_cents\\\":0,\\n               \\\"currency\\\":\\\"USD\\\",\\n               \\\"symbol\\\":\\\"$\\\",\\n               \\\"display\\\":\\\"FREE\\\"\\n            },\\n            \\\"total\\\":{  \\n               \\\"amount\\\":\\\"87.00\\\",\\n               \\\"amount_cents\\\":8700,\\n               \\\"currency\\\":\\\"USD\\\",\\n               \\\"symbol\\\":\\\"$\\\",\\n               \\\"display\\\":\\\"$87\\\"\\n            },\\n            \\\"fully_refundable_amount\\\":{  \\n               \\\"amount\\\":\\\"87.00\\\",\\n               \\\"amount_cents\\\":8700,\\n               \\\"currency\\\":\\\"USD\\\",\\n               \\\"symbol\\\":\\\"$\\\",\\n               \\\"display\\\":\\\"$87\\\"\\n            }\\n         },\\n         \\\"_links\\\":{  \\n            \\\"self\\\":{  \\n               \\\"href\\\":\\\"https://api.reverb.com/api/my/refund_requests/selling/47\\\"\\n            }\\n         }\\n      }\\n   ]\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Responding to Buyer-Initiated Refund Requests\"\n}\n[/block]\nConditionally approving a refund, including a note to the buyer:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl \\\\           \\n-XPUT \\\\\\n-H \\\"Authorization: Bearer [token]\\\" \\\\\\n-H \\\"Content-Type: application/hal+json\\\" \\\\\\n-H \\\"Accept-Version: 3.0\\\" \\\\\\n-d '{\\\"state\\\":\\\"conditionally_approved\\\",\\\"note_to_buyer\\\":\\\"hello\\\"}' \\\\\\nhttps://api.reverb.com/api/my/refund_requests/selling/1\",\n      \"language\": \"curl\"\n    }\n  ]\n}\n[/block]\nApproving a refund:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl \\\\      \\n-XPUT \\\\\\n-H \\\"Authorization: Bearer [token]\\\" \\\\\\n-H \\\"Content-Type: application/hal+json\\\" \\\\\\n-H \\\"Accept-Version: 3.0\\\" \\\\\\n-d '{\\\"state\\\":\\\"approved\\\"}' \\\\\\nhttps://api.reverb.com/api/my/refund_requests/selling/1\",\n      \"language\": \"curl\"\n    }\n  ]\n}\n[/block]\nDenying a refund:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl \\\\                \\n-XPUT \\\\\\n-H \\\"Authorization: Bearer [token]\\\" \\\\\\n-H \\\"Content-Type: application/hal+json\\\" \\\\\\n-H \\\"Accept-Version: 3.0\\\" \\\\\\n-d '{\\\"state\\\":\\\"denied\\\"}' \\\\\\nhttps://api.reverb.com/api/my/refund_requests/selling/1\",\n      \"language\": \"curl\"\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"title\": \"Creating a Seller-Initiated Refund Request\"\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl \\\\              \\n-XPOST \\\\\\n-H \\\"Authorization: Bearer [token]\\\" \\\\\\n-H \\\"Content-Type: application/hal+json\\\" \\\\\\n-H \\\"Accept-Version: 3.0\\\" \\\\\\n-d '{\\\"state\\\":\\\"conditionally_approved\\\",\\\"reason\\\":\\\"buyer_no_like\\\",\\\"refund_amount\\\":{\\\"amount\\\":\\\"10.00\\\",\\\"currency\\\":\\\"USD\\\"}}' \\\\\\nhttps://api.reverb.com/api/my/orders/selling/1/refund_requests\",\n      \"language\": \"curl\"\n    }\n  ]\n}\n[/block]\nThe `reason` parameter is required and must be one of the following values:\n\n- `buyer_change_of_heart`\n- `buyer_no_like`\n- `buyer_return`\n- `lost_shipment`\n- `shipping_damage`\n- `sold_elsewhere`\n- `item_defective`\n- `other`","excerpt":"","slug":"manage-refund-requests","type":"basic","title":"Manage Refund Requests"}

Manage Refund Requests


[block:api-header] { "title": "Refund Request Lifecycle" } [/block] After an order has been placed, the buyer may initiate a refund, which creates a refund request in a `pending_seller_response` state. The seller may respond via Reverb's API by updating the refund request with one of the following states: - `conditionally_approved`: Approve the refund after the item has been returned. The refund request is still active and will need to be approved at a later time. - `approved`: Approve the refund immediately, typically after the item has been returned. This will immediately credit the buyer and debit the seller. Once approved, the refund request is completed and no further action is needed. - `denied`: Deny the refund, which will complete the refund request without crediting the buyer or debiting the seller. Once denied, the refund request is completed and no further action is needed. When responding to a refund request by approving or conditionally approving, the seller may also change the amount to be refunded. A single order can have multiple refund requests, as long as the order has not been fully refunded. [block:api-header] { "title": "Getting a List of Refund Requests" } [/block] By default, refund requests with an active state (`pending_seller_response` or `conditionally_approved`) are returned. These can be filtered by created date range or updated date range: [block:code] { "codes": [ { "code": "curl \\\n-XGET \\\n-H \"Authorization: Bearer [oauth_token]\" \\\n-H \"Content-Type: application/hal+json\" \\\n-H \"Accept-Version: 3.0\" \\\nhttps://api.reverb.com/api/my/refund_requests?created_start_date=2017-10-01T12:00-00:00&created_end_date=2017-10-31T12:00-00:00", "language": "curl" } ] } [/block] [block:code] { "codes": [ { "code": "curl \\\n-XGET \\\n-H \"Authorization: Bearer [oauth_token]\" \\\n-H \"Content-Type: application/hal+json\" \\\n-H \"Accept-Version: 3.0\" \\\nhttps://api.reverb.com/api/my/refund_requests?updated_start_date=2017-10-01T12:00-00:00&updated_end_date=2017-10-31T12:00-00:00", "language": "curl" } ] } [/block] Refund requests can also be filtered to an individual state, a list of states, and paginated through: [block:code] { "codes": [ { "code": "curl \\\n-XGET \\\n-H \"Authorization: Bearer [oauth_token]\" \\\n-H \"Content-Type: application/hal+json\" \\\n-H \"Accept-Version: 3.0\" \\\nhttps://api.reverb.com/api/my/refund_requests?state=approved", "language": "curl", "name": null } ] } [/block] [block:code] { "codes": [ { "code": "curl \\\n-XGET \\\n-H \"Authorization: Bearer [oauth_token]\" \\\n-H \"Content-Type: application/hal+json\" \\\n-H \"Accept-Version: 3.0\" \\\n'https://api.reverb.com/api/my/refund_requests?state[]=approved&state[]=conditionally_approved'", "language": "curl" } ] } [/block] [block:code] { "codes": [ { "code": "curl \\\n-XGET \\\n-H \"Authorization: Bearer [oauth_token]\" \\\n-H \"Content-Type: application/hal+json\" \\\n-H \"Accept-Version: 3.0\" \\\nhttps://api.reverb.com/api/my/refund_requests?page=1&per_page=1", "language": "curl" } ] } [/block] The response format includes a list of refund requests and its associated order: [block:code] { "codes": [ { "code": "{ \n \"total\":2,\n \"current_page\":1,\n \"per_page\":1,\n \"total_pages\":2,\n \"_links\":{ \n \"next\":{ \n \"href\":\"https://api.reverb.com/api/my/refund_requests/selling?page=2&per_page=1&state=conditionally_approved\"\n }\n },\n \"refund_requests\":[ \n { \n \"id\":47,\n \"state\":\"conditionally_approved\",\n \"amount\":{ \n \"amount\":\"87.00\",\n \"amount_cents\":8700,\n \"currency\":\"USD\",\n \"symbol\":\"$\",\n \"display\":\"$87\"\n },\n \"refund_type\":\"full\",\n \"reason\":\"buyer_return\",\n \"initiated_by\":\"buyer\",\n \"note_to_buyer\":\"\",\n \"created_at\":\"2017-05-12T09:56:03-05:00\",\n \"updated_at\":\"2017-05-12T09:56:03-05:00\",\n \"order\":{ \n \"buyer_id\":\"1651\",\n \"order_number\":\"290\",\n \"paid_at\":\"2017-05-12T09:54:25-05:00\",\n \"quantity\":1,\n \"shipping_address\":{ \n \"region\":\"IL\",\n \"locality\":\"Chicago\",\n \"country_code\":\"US\",\n \"display_location\":\"Chicago, IL, United States\"\n },\n \"shipping_date\":\"2017-05-12\",\n \"shipped_at\":\"2017-05-12T09:55:15-05:00\",\n \"shipping_provider\":\"USPS\",\n \"shipping_code\":\"9410836897846109604096\",\n \"shipping_method\":\"shipped\",\n \"local_pickup\":false,\n \"status\":\"shipped\",\n \"product_id\":\"637\",\n \"order_bundle_id\":\"162\",\n \"created_at\":\"2017-05-12T09:54:23-05:00\",\n \"amount_product\":{ \n \"amount\":\"77.00\",\n \"amount_cents\":7700,\n \"currency\":\"USD\",\n \"symbol\":\"$\",\n \"display\":\"$77\"\n },\n \"amount_product_subtotal\":{ \n \"amount\":\"77.00\",\n \"amount_cents\":7700,\n \"currency\":\"USD\",\n \"symbol\":\"$\",\n \"display\":\"$77\"\n },\n \"shipping\":{ \n \"amount\":\"10.00\",\n \"amount_cents\":1000,\n \"currency\":\"USD\",\n \"symbol\":\"$\",\n \"display\":\"$10\"\n },\n \"amount_tax\":{ \n \"amount\":\"0.00\",\n \"amount_cents\":0,\n \"currency\":\"USD\",\n \"symbol\":\"$\",\n \"display\":\"FREE\"\n },\n \"total\":{ \n \"amount\":\"87.00\",\n \"amount_cents\":8700,\n \"currency\":\"USD\",\n \"symbol\":\"$\",\n \"display\":\"$87\"\n },\n \"fully_refundable_amount\":{ \n \"amount\":\"87.00\",\n \"amount_cents\":8700,\n \"currency\":\"USD\",\n \"symbol\":\"$\",\n \"display\":\"$87\"\n }\n },\n \"_links\":{ \n \"self\":{ \n \"href\":\"https://api.reverb.com/api/my/refund_requests/selling/47\"\n }\n }\n }\n ]\n}", "language": "json" } ] } [/block] [block:api-header] { "type": "basic", "title": "Responding to Buyer-Initiated Refund Requests" } [/block] Conditionally approving a refund, including a note to the buyer: [block:code] { "codes": [ { "code": "curl \\ \n-XPUT \\\n-H \"Authorization: Bearer [token]\" \\\n-H \"Content-Type: application/hal+json\" \\\n-H \"Accept-Version: 3.0\" \\\n-d '{\"state\":\"conditionally_approved\",\"note_to_buyer\":\"hello\"}' \\\nhttps://api.reverb.com/api/my/refund_requests/selling/1", "language": "curl" } ] } [/block] Approving a refund: [block:code] { "codes": [ { "code": "curl \\ \n-XPUT \\\n-H \"Authorization: Bearer [token]\" \\\n-H \"Content-Type: application/hal+json\" \\\n-H \"Accept-Version: 3.0\" \\\n-d '{\"state\":\"approved\"}' \\\nhttps://api.reverb.com/api/my/refund_requests/selling/1", "language": "curl" } ] } [/block] Denying a refund: [block:code] { "codes": [ { "code": "curl \\ \n-XPUT \\\n-H \"Authorization: Bearer [token]\" \\\n-H \"Content-Type: application/hal+json\" \\\n-H \"Accept-Version: 3.0\" \\\n-d '{\"state\":\"denied\"}' \\\nhttps://api.reverb.com/api/my/refund_requests/selling/1", "language": "curl" } ] } [/block] [block:api-header] { "title": "Creating a Seller-Initiated Refund Request" } [/block] [block:code] { "codes": [ { "code": "curl \\ \n-XPOST \\\n-H \"Authorization: Bearer [token]\" \\\n-H \"Content-Type: application/hal+json\" \\\n-H \"Accept-Version: 3.0\" \\\n-d '{\"state\":\"conditionally_approved\",\"reason\":\"buyer_no_like\",\"refund_amount\":{\"amount\":\"10.00\",\"currency\":\"USD\"}}' \\\nhttps://api.reverb.com/api/my/orders/selling/1/refund_requests", "language": "curl" } ] } [/block] The `reason` parameter is required and must be one of the following values: - `buyer_change_of_heart` - `buyer_no_like` - `buyer_return` - `lost_shipment` - `shipping_damage` - `sold_elsewhere` - `item_defective` - `other`