Miracle Docs
Withdrawals

List withdrawal method catalog entries

Returns the platform-wide catalog of supported withdrawal method types. Each entry defines the machine-readable type key, a human-readable label, and a JSON schema describing the required details fields. Use this catalog to render the "add withdrawal method" form in merchant portals.

GET
/v1/withdrawal-method-catalog
AuthorizationBearer <token>

In: header

Response Body

application/json

curl -X GET "https://<api-host>/v1/withdrawal-method-catalog"
{
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "type": "string",
      "label": "string",
      "description": "string",
      "fieldSchema": {
        "property1": null,
        "property2": null
      },
      "status": "active",
      "createdAt": "string",
      "updatedAt": "string",
      "deletedAt": null
    }
  ],
  "pagination": {
    "nextCursor": "string",
    "prevCursor": "string",
    "hasMore": true,
    "totalCount": 0
  }
}

On this page