create_refund_offer

The first step is to create and send a refund object to Apace. You can refer to the Apace external module Create Refund Offer for the API details

See below for a sample of the create refund object

{
	"card_last_four": "1111",
	"expiration_date": "2022-05-21T22:24:15.761Z",
	"order_id": "5448-554-48980",
	"order_url": "https://vendor.com/orders/5448-5565944-545",
	"order_date": "12/20/2021",
  "refund_amount": "50.97",
	"customer": {
		"first_name": "John",
		"last_name": "Doe",
		"email": "[email protected]"
	},
	"items": [
    {
      "item_id": "1234523",
      "sku": "ABC-123",
      "item_url": "https://vendor.com/items/123456",
      "item_image_url": "https://m.media-amazon.com/images/I/51v-g-1IeUL._SS142_.jpg",
      "display_name": "Diapers Size 5, 148 Count - Luvs Triple Leakguards Disposable Baby Diapers, ONE MONTH SUPPLY",
      "return_date": "01/02/2022",
      "unit_price": 50.97,
      "return_qty": 1
    }
	],
	"refund_verification":{
		"url":"https://api.vendor.com/varify-refund?order_id=5448-556544-545&item_ids=123456&auth_token=jhkSAHF454SDFSDF454sDf52sdf2",
		"method":"GET"
	},
	"refund_notification":{
		"webhook_url":"https://api.vendor.com/refund-notification?order_id=5448-556544-545&item_ids=123456&auth_token=jhkSAHF454SDFSDF454sDf52sdf2",
		"redirect_url":"https://vendor.com/refund-confirmation?order_id=5448-556544-545&item_ids=123456&auth_token=jhkSAHF454SDFSDF454sDf52sdf2",
		"redirect_method":"POST"
	}
}

refund_verification

The refund_verification URL is for Apace to verify that the merchant authorizes us to send the refund and that they didn't yet issue a card reversal refund

The refund_verification URL should return the following

{
    "allow_refund":true|false,
    "refund_issued": true|false (optional)
}

Optional to add refund_issued: true this will result Apace to show a nice message to the customer that the regular time refund was already sent by the merchant.

refund_notification

The refund_notification.webhook_url is used to update your server as soon as Apace sends the refund to your customer so you can update your database to avoid duplicate refunds. See the Refund successful webhook
The refund_notification.redirect_url is used to redirect your customer to any URL of your choice after a successful refund

When a 'create refund' is successful, Apace will respond with the following data

refund_link: the unique link to send to the customer
refund_id: for your records and to have Apace send the Send Refund Offer Email
active_until: until when this refund offer should be valid (default 10 days, but you have the option to add as you prefer)

See below for a successful response

{
    "refund_created": true,
    "refund_link": "https://customer.apacerefunds.com/refunds/process/en/create_refund/eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJyZWZ1bmRJZCI6Ijg1YTY0M2Y3LWNlZjgtNDk0Zi04YmNlLTc1ZmExNmI2YzI1MiIsImlhdCI6MTY0OTc3NDQ4MywiZXhwIjoxNjUzMTcxODU0fQ.IzqrR04SOfMl0n-vveN7kO_EbxY6ZZcw5-TVzprKcLc?refund_id=85a643f7-cef8-494f-8bce-75fa16b6c252&vendor_id=17",
    "refund_id": "85a643f7-cef8-494f-8bce-75fa16b6c252",
    "active_until": "2022-05-21T22:24:15.761Z"
}

You have the option to either send an email to your customer with the unique refund_link included.
Or, Apace can send an email with the refund and item details via the Send Refund Offer Email API

Next, send an instant offer email