Miracle Docs
Withdrawals

List merchant withdrawal methods

Returns a paginated list of saved withdrawal methods visible to the caller. Filters: merchantId, methodType, status. Rows always belong to the caller mode. Cursor-based pagination — default page size 20, maximum 100.

GET
/v1/merchant-withdrawal-methods
AuthorizationBearer <token>

In: header

Query Parameters

merchantId?string

Filter by merchant ID (UUID v7).

Formatuuid
methodType?string

Filter by catalog type key (e.g. "sepa_bank_transfer").

status?string

Filter by lifecycle status (cooling, active, suspended).

Value in"cooling" | "active" | "suspended"
livemode?string

Accepted for compatibility. Methods always belong to the caller mode.

Value in"true" | "false"
cursor?string

Pagination cursor from a previous list response.

Formatuuid
limit?integer

Page size. Default 20, maximum 100.

Default20
Range1 <= value <= 100
sortOrder?string

Sort by createdAt. Defaults to descending (newest first).

Value in"asc" | "desc"

Response Body

application/json

curl -X GET "https://<api-host>/v1/merchant-withdrawal-methods"
{
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
      "livemode": true,
      "merchantId": "c3073b9d-edd0-49f2-a28d-b7ded8ff9a8b",
      "methodType": "string",
      "label": "string",
      "details": {
        "property1": "string",
        "property2": "string"
      },
      "status": "cooling",
      "activatesAt": "string",
      "createdAt": "string",
      "updatedAt": "string",
      "deletedAt": null
    }
  ],
  "pagination": {
    "nextCursor": "string",
    "prevCursor": "string",
    "hasMore": true,
    "totalCount": 0
  }
}
Empty

On this page