List Refund Requests

Development

https://api-dev.getroamify.com

GET

/api/refunds

Refunds

Last modified:2026-11-09 07:06:07

Maintainer:Not configured

Lists the refund requests filed by your account, newest first. All query parameters are optional filters: status (PENDING, PROCESSING, REFUNDED, REJECTED, CANCELLED), esimId or iccid (provide at most one), limit (default 20, maximum 100) and cursor. Pass nextCursor from the previous response as cursor to fetch the next page.

Request

Query Params

Header Params

Responses

🟢200

application/json

A page of refund requests

Bodyapplication/json

🟠400

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://api-dev.getroamify.com/api/refunds?status=&esimId=&iccid=&limit=&cursor=' \
--header 'Authorization: Bearer roamify_3fegvaRHZxZoAsB7Yg5KFs5ymSg3kBN1trn4DxRrqW1mDRoo9DueN6FSfNTuGndVGpR2iTyH4UVmZf39tVb5muWUPqBm1dh5eHiH5WkPN3wGLF8cr7MhemqekwK7rdqFizTZD9VDRq5P5RHAXzL2tCHfcrsskg2YoP8JE1fndNoiQCUSS1GBUUpmH'

Response Example

200 - Example 1

{
    "status": "success",
    "data": {
        "items": [
            {
                "refundId": "string",
                "status": "PENDING",
                "productType": "esim",
                "item": {
                    "esimId": "string",
                    "iccid": "string",
                    "orderId": "string",
                    "referenceId": "string",
                    "countryName": "Japan",
                    "optionName": "5GB - 30 days"
                },
                "reason": "UNABLE_TO_INSTALL",
                "notes": "string",
                "amount": 0,
                "currency": "string",
                "balanceCreditUsd": 0,
                "transaction": {
                    "id": "string",
                    "paymentMethod": "string",
                    "paymentStatus": "string",
                    "refundedAt": 0
                },
                "rejectionReason": "string",
                "rejectionNote": "string",
                "createdAt": 0,
                "updatedAt": 0,
                "processedAt": 0,
                "cancelledAt": 0,
                "history": [
                    {
                        "status": "PENDING",
                        "at": 0
                    }
                ]
            }
        ],
        "nextCursor": "string"
    }
}

Modified at 2026-11-09 07:06:07

Create Bulk Refund Requests

Cancel Refund Request