Purchases Refund | SimJuno Documentation

Refund a purchase

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

purchaseIdstringRequiredformat: "uuid"

This endpoint expects an object.

refundTypeenumRequired

Allowed values:

confirmedbooleanOptional

Successful response

successboolean

messagestring

confirmation_requiredbooleanDefaults to false

warningstringDefaults to

awaiting_whitelistbooleanDefaults to false

can_retrybooleanDefaults to false

whitelist_csvstringDefaults to

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

500

Internal Server Error

1	const url = 'http://localhost:3001/v1/admin/purchases/purchaseId/refund';
2	const options = {
3	method: 'POST',
4	headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
5	body: '{"refundType":"to_balance"}'
6	};
7
8	try {
9	const response = await fetch(url, options);
10	const data = await response.json();
11	console.log(data);
12	} catch (error) {
13	console.error(error);
14	}

1	{
2	"success": true,
3	"message": "string",
4	"confirmation_required": false,
5	"warning": "",
6	"awaiting_whitelist": false,
7	"can_retry": false,
8	"whitelist_csv": ""
9	}