List Transfers

curl "/api/v1/transfers?status=completed&fromDate=2025-01-01T00:00:00.000Z&limit=50" \
  -H "x-api-key: mh_live_abc123..."

{
  "items": [
    {
      "id": 42,
      "externalId": "order_12345",
      "status": "completed",
      "phase": "settled",
      "progress": { "hopsCompleted": 7, "hopsTotal": 7 }
    }
  ],
  "pagination": {
    "total": 142,
    "limit": 50,
    "offset": 0
  }
}

GET

api

transfers

curl "/api/v1/transfers?status=completed&fromDate=2025-01-01T00:00:00.000Z&limit=50" \
  -H "x-api-key: mh_live_abc123..."

{
  "items": [
    {
      "id": 42,
      "externalId": "order_12345",
      "status": "completed",
      "phase": "settled",
      "progress": { "hopsCompleted": 7, "hopsTotal": 7 }
    }
  ],
  "pagination": {
    "total": 142,
    "limit": 50,
    "offset": 0
  }
}

Query parameters

status

string

Filter by transfer status (e.g. completed, processing, failed).

fromDate

string

ISO 8601 start date filter (e.g. 2025-01-01T00:00:00.000Z).

toDate

string

ISO 8601 end date filter.

externalId

string

Filter by your external ID.

supportBundleId

string

Filter by support bundle ID.

limit

integer

default:"50"

Number of results to return.

offset

integer

default:"0"

Pagination offset.

Response

items

array

Array of transfer objects.

pagination

object

Show pagination fields

pagination.total

integer

Total number of matching transfers.

pagination.limit

integer

Page size used.

pagination.offset

integer

Current offset.

curl "/api/v1/transfers?status=completed&fromDate=2025-01-01T00:00:00.000Z&limit=50" \
  -H "x-api-key: mh_live_abc123..."

{
  "items": [
    {
      "id": 42,
      "externalId": "order_12345",
      "status": "completed",
      "phase": "settled",
      "progress": { "hopsCompleted": 7, "hopsTotal": 7 }
    }
  ],
  "pagination": {
    "total": 142,
    "limit": 50,
    "offset": 0
  }
}

Get Transfer Register Webhook

API documentation

Transfers

Webhooks

Integration

Query parameters

Response

​Query parameters

​Response

Query parameters

Response