`paypal_get_order`

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

Get full details of a PayPal order by ID (e.g., “3JU84394D694620H”). Returns buyer info, items, amounts, and fulfillment 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)
`order_id`	string	yes	PayPal order ID

Example call

Arguments

{
  "_clientId": "your-paypal-client-id",
  "_clientSecret": "your-paypal-client-secret",
  "order_id": "3JU84394D694620H"
}

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_order","arguments":{"_clientId":"your-paypal-client-id","_clientSecret":"your-paypal-client-secret","order_id":"3JU84394D694620H"}}}'

TypeScript (@pipeworx/sdk)

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

const result = await pipeworx.call('paypal_get_order', {
  "_clientId": "your-paypal-client-id",
  "_clientSecret": "your-paypal-client-secret",
  "order_id": "3JU84394D694620H"
});

Response shape

Field	Type	Description
`id`	string	Order ID
`status`	string	Order status (e.g., CREATED, APPROVED, VOIDED, COMPLETED)
`payer`	object	Payer information
`purchase_units`	array	Items and amounts in the order
`create_time`	string	Order creation timestamp
`update_time`	string	Order last update timestamp
`links`	array

Full JSON Schema

{
  "type": "object",
  "description": "Full details of a PayPal order",
  "properties": {
    "id": {
      "type": "string",
      "description": "Order ID"
    },
    "status": {
      "type": "string",
      "description": "Order status (e.g., CREATED, APPROVED, VOIDED, COMPLETED)"
    },
    "payer": {
      "type": "object",
      "description": "Payer information",
      "properties": {
        "name": {
          "type": "object",
          "properties": {
            "given_name": {
              "type": "string",
              "description": "First name"
            },
            "surname": {
              "type": "string",
              "description": "Last name"
            }
          }
        },
        "email_address": {
          "type": "string",
          "description": "Payer email"
        },
        "address": {
          "type": "object",
          "properties": {
            "address_line_1": {
              "type": "string",
              "description": "Street address"
            },
            "admin_area_2": {
              "type": "string",
              "description": "City"
            },
            "admin_area_1": {
              "type": "string",
              "description": "State"
            },
            "postal_code": {
              "type": "string",
              "description": "Postal code"
            },
            "country_code": {
              "type": "string",
              "description": "Country code"
            }
          }
        }
      }
    },
    "purchase_units": {
      "type": "array",
      "description": "Items and amounts in the order",
      "items": {
        "type": "object",
        "properties": {
          "reference_id": {
            "type": "string",
            "description": "Reference ID"
          },
          "amount": {
            "type": "object",
            "properties": {
              "currency_code": {
                "type": "string",
                "description": "Currency code"
              },
              "value": {
                "type": "string",
                "description": "Total amount"
              },
              "breakdown": {
                "type": "object",
                "properties": {
                  "item_total": {
                    "type": "object",
                    "properties": {
                      "currency_code": {
                        "type": "string"
                      },
                      "value": {
                        "type": "string"
                      }
                    }
                  },
                  "shipping": {
                    "type": "object",
                    "properties": {
                      "currency_code": {
                        "type": "string"
                      },
                      "value": {
                        "type": "string"
                      }
                    }
                  },
                  "tax_total": {
                    "type": "object",
                    "properties": {
                      "currency_code": {
                        "type": "string"
                      },
                      "value": {
                        "type": "string"
                      }
                    }
                  }
                }
              }
            }
          },
          "items": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "name": {
                  "type": "string",
                  "description": "Item name"
                },
                "unit_amount": {
                  "type": "object",
                  "properties": {
                    "currency_code": {
                      "type": "string"
                    },
                    "value": {
                      "type": "string"
                    }
                  }
                },
                "quantity": {
                  "type": "string",
                  "description": "Item quantity"
                }
              }
            }
          },
          "shipping": {
            "type": "object",
            "properties": {
              "address": {
                "type": "object",
                "properties": {
                  "address_line_1": {
                    "type": "string"
                  },
                  "admin_area_2": {
                    "type": "string"
                  },
                  "admin_area_1": {
                    "type": "string"
                  },
                  "postal_code": {
                    "type": "string"
                  },
                  "country_code": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    "create_time": {
      "type": "string",
      "description": "Order creation timestamp"
    },
    "update_time": {
      "type": "string",
      "description": "Order last update timestamp"
    },
    "links": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "href": {
            "type": "string",
            "description": "URL link"
          },
          "rel": {
            "type": "string",
            "description": "Link relation (e.g., self, approve)"
          },
          "method": {
            "type": "string",
            "description": "HTTP method"
          }
        }
      }
    }
  }
}

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_order