The API Cancel endpoint
The Cancel Profile end point is for cases where an eSIM has been purchased, and not installed yet. In cases where the purchased ESIM profile is unused and not yet installed on any device the cancel endpoint can be invoked for a full refund.
The cancel endpoint functionality will no longer be available in the case the eSIM is installed on a device already. This endpoint is suitable for using in testing cases as well as refunding mistaken purchases.
Perquisites
Before you get started, make sure you have a free Postman account, eSIM Access account, have funded your account and have made a single eSIM purchase.
Follow these steps to make a Cancel request
Lets go thru the steps to make a purchase.
- First, verify you have an unused eSIM profile in your account.
- Locate the ICCID number of the eSIM you wish to cancel
- In the cancel profile endpoint enter the ICCID number in the JSON body payload
- Make the request
- Check the billing history to see history of your refund.
- Optional – check the status of the ICCID to see the CANCELED status
Setup steps in more detail
Before proceeding, confirm that you have an unused eSIM profile available in your account. This ensures that there is a profile to cancel.
ICCID stands for Integrated Circuit Card Identifier, which uniquely identifies the eSIM. Locate the ICCID number of the eSIM you want to cancel. This number is located in the eSIM payload of a recent order.
Utilize the API’s cancel profile endpoint, construct a request to this endpoint and include the ICCID number in the JSON body payload. This informs the API which eSIM profile you want to cancel.
Send the request to the cancel profile endpoint. Ensure that the request is properly authenticated and includes the necessary headers or authentication tokens.
Check Billing History: After the cancellation request, review the billing history associated with your account. This will provide details about the refund, if applicable, related to the canceled eSIM profile. This step allows you to track any financial adjustments associated with the cancellation.
Optional – Check ICCID Status: If you want to confirm the status of the eSIM profile after cancellation, you can use the API to check the ICCID status. Look for the CANCELED status to ensure that the cancellation was successfully processed.
