search_payments

Parameters schema

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {
    "limit": {
      "type": "integer",
      "maximum": 200,
      "minimum": 1,
      "description": "Number of results per page. Defaults to 50."
    },
    "query": {
      "type": "string",
      "description": "Free-text search: tx hash, email, reference ID, customer ID, or invoice ID."
    },
    "dateTo": {
      "type": "string",
      "description": "End date filter (ISO 8601, e.g. 2024-12-31T23:59:59Z)."
    },
    "offset": {
      "type": "integer",
      "maximum": 9007199254740991,
      "minimum": 0,
      "description": "Pagination offset. Defaults to 0."
    },
    "sortBy": {
      "type": "string",
      "description": "Sort field. Valid: created_at, updated_at, payment_status, currency, network, block_id, from_address, to_address, invoice_id, reference_id, customer_id, email, created_by."
    },
    "network": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Filter by blockchain network (e.g. BTC, ETH, TRX, BASE, POLYGON)."
    },
    "currency": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Filter by currency code (e.g. USDC, USDT, BTC, ETH, TRX, CBBTC)."
    },
    "dateFrom": {
      "type": "string",
      "description": "Start date filter (ISO 8601, e.g. 2024-01-01T00:00:00Z)."
    },
    "createdBy": {
      "type": "array",
      "items": {
        "enum": [
          "user",
          "system"
        ],
        "type": "string"
      },
      "description": "Filter by creator type."
    },
    "paymentStatus": {
      "type": "array",
      "items": {
        "enum": [
          "OPEN",
          "FILLED",
          "PARTIALLY_FILLED",
          "OVER_FILLED",
          "CANCELLED",
          "CONFIRMING",
          "DEPOSIT_RECEIVED",
          "UNDEFINED"
        ],
        "type": "string"
      },
      "description": "Filter by payment status (FILLED = completed)."
    },
    "sortDirection": {
      "enum": [
        "ASC",
        "DESC"
      ],
      "type": "string",
      "description": "Sort direction. Defaults to DESC."
    },
    "webhookStatus": {
      "type": "array",
      "items": {
        "enum": [
          "received",
          "pending",
          "failed",
          "waiting_for_approval",
          "discarded"
        ],
        "type": "string"
      },
      "description": "Filter by webhook delivery status."
    },
    "externalPlatformId": {
      "type": "string",
      "description": "Optional. Auto-discovered from your account if omitted."
    }
  },
  "additionalProperties": false
}

• Packagenpm: payram
  declared dependency0.85

Parent server