`paypal_get_invoice`

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

Get full details of a PayPal invoice by ID. Returns line items, amounts, due dates, and payment status.

Parameters

Name	Type	Required	Description
`_clientId`	string	yes	PayPal app Client ID
`_clientSecret`	string	yes	PayPal app Client Secret
`_sandbox`	boolean	no	Use sandbox environment (default: false)
`invoice_id`	string	yes	PayPal invoice ID (e.g., INV2-XXXX-XXXX-XXXX-XXXX)

Example call

Arguments

{
  "_clientId": "your-paypal-client-id",
  "_clientSecret": "your-paypal-client-secret",
  "invoice_id": "INV2-1234-5678-9ABC-DEF0"
}

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_get_invoice","arguments":{"_clientId":"your-paypal-client-id","_clientSecret":"your-paypal-client-secret","invoice_id":"INV2-1234-5678-9ABC-DEF0"}}}'

TypeScript (@pipeworx/sdk)

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

const result = await pipeworx.call('paypal_get_invoice', {
  "_clientId": "your-paypal-client-id",
  "_clientSecret": "your-paypal-client-secret",
  "invoice_id": "INV2-1234-5678-9ABC-DEF0"
});

Response shape

Field	Type	Description
`id`	string	Invoice ID
`number`	string	Invoice number
`status`	string	Invoice status
`amount`	object
`due_date`	string	Due date in ISO 8601 format
`items`	array	Invoice line items
`customer`	object
`create_time`	string	Creation timestamp
`update_time`	string	Last update timestamp

Full JSON Schema

{
  "type": "object",
  "description": "Full details of a PayPal invoice",
  "properties": {
    "id": {
      "type": "string",
      "description": "Invoice ID"
    },
    "number": {
      "type": "string",
      "description": "Invoice number"
    },
    "status": {
      "type": "string",
      "description": "Invoice status"
    },
    "amount": {
      "type": "object",
      "properties": {
        "currency_code": {
          "type": "string",
          "description": "Currency code"
        },
        "value": {
          "type": "string",
          "description": "Total amount"
        }
      }
    },
    "due_date": {
      "type": "string",
      "description": "Due date in ISO 8601 format"
    },
    "items": {
      "type": "array",
      "description": "Invoice line items",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "description": "Item name"
          },
          "description": {
            "type": "string",
            "description": "Item description"
          },
          "quantity": {
            "type": "string",
            "description": "Item quantity"
          },
          "unit_amount": {
            "type": "object",
            "properties": {
              "currency_code": {
                "type": "string"
              },
              "value": {
                "type": "string"
              }
            }
          },
          "amount": {
            "type": "object",
            "properties": {
              "currency_code": {
                "type": "string"
              },
              "value": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "customer": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "description": "Customer name"
        },
        "email": {
          "type": "string",
          "description": "Customer email"
        }
      }
    },
    "create_time": {
      "type": "string",
      "description": "Creation timestamp"
    },
    "update_time": {
      "type": "string",
      "description": "Last update timestamp"
    }
  }
}

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.

paypal_get_invoice