paypal_list_transactions

Pack: paypal · Endpoint: https://gateway.pipeworx.io/paypal/mcp

Find PayPal transactions within a date range. Returns amount, status, payer info, and transaction IDs. Use to audit payments or track cash flow.

Parameters

NameTypeRequiredDescription
_clientIdstringyesPayPal app Client ID
_clientSecretstringyesPayPal app Client Secret
_sandboxbooleannoUse sandbox environment (default: false)
start_datestringyesStart date in ISO 8601 format (e.g., 2024-01-01T00:00:00Z)
end_datestringyesEnd date in ISO 8601 format (e.g., 2024-12-31T23:59:59Z)

Example call

Arguments

{
  "_clientId": "your-paypal-client-id",
  "_clientSecret": "your-paypal-client-secret",
  "start_date": "2024-01-01T00:00:00Z",
  "end_date": "2024-12-31T23:59:59Z"
}

curl

curl -X POST https://gateway.pipeworx.io/paypal/mcp \
  -H 'Content-Type: application/json' \
  -d '{"jsonrpc":"2.0","id":1,"method":"tools/call","params":{"name":"paypal_list_transactions","arguments":{"_clientId":"your-paypal-client-id","_clientSecret":"your-paypal-client-secret","start_date":"2024-01-01T00:00:00Z","end_date":"2024-12-31T23:59:59Z"}}}'

TypeScript (@pipeworx/sdk)

import { Pipeworx } from '@pipeworx/sdk';
const pipeworx = new Pipeworx();

const result = await pipeworx.call('paypal_list_transactions', {
  "_clientId": "your-paypal-client-id",
  "_clientSecret": "your-paypal-client-secret",
  "start_date": "2024-01-01T00:00:00Z",
  "end_date": "2024-12-31T23:59:59Z"
});

More examples

{
  "_clientId": "your-paypal-client-id",
  "_clientSecret": "your-paypal-client-secret",
  "start_date": "2024-09-01T00:00:00Z",
  "end_date": "2024-09-30T23:59:59Z",
  "_sandbox": true
}

Response shape

FieldTypeDescription
transaction_detailsarrayArray of transactions
pagenumberCurrent page number
total_itemsnumberTotal number of transactions
total_pagesnumberTotal number of pages
Full JSON Schema
{
  "type": "object",
  "description": "List of PayPal transactions within a date range",
  "properties": {
    "transaction_details": {
      "type": "array",
      "description": "Array of transactions",
      "items": {
        "type": "object",
        "properties": {
          "transaction_id": {
            "type": "string",
            "description": "Unique transaction ID"
          },
          "transaction_date": {
            "type": "string",
            "description": "Transaction date in ISO 8601 format"
          },
          "transaction_amount": {
            "type": "object",
            "properties": {
              "currency_code": {
                "type": "string",
                "description": "Currency code (e.g., USD)"
              },
              "value": {
                "type": "string",
                "description": "Transaction amount"
              }
            }
          },
          "payer_name": {
            "type": "object",
            "properties": {
              "given_name": {
                "type": "string",
                "description": "First name"
              },
              "surname": {
                "type": "string",
                "description": "Last name"
              }
            }
          },
          "payer_email": {
            "type": "string",
            "description": "Payer email address"
          },
          "transaction_status": {
            "type": "string",
            "description": "Transaction status (e.g., S, D, F)"
          }
        }
      }
    },
    "page": {
      "type": "number",
      "description": "Current page number"
    },
    "total_items": {
      "type": "number",
      "description": "Total number of transactions"
    },
    "total_pages": {
      "type": "number",
      "description": "Total number of pages"
    }
  }
}

Connect

Add this to your MCP client config, or use one-click install buttons:

{
  "mcpServers": {
    "paypal": {
      "url": "https://gateway.pipeworx.io/paypal/mcp"
    }
  }
}

See Getting Started for client-specific install steps.

Regenerated from source · build May 9, 2026