PayPal

Process payments, manage orders, and handle disputes via the PayPal REST API.

Detail	Value
Category	Payments
Base URL	https://api-m.paypal.com
Authentication	OAuth2 Client Credentials
Endpoints	6
Connector key	paypal

Using PayPal in a workflow

1. Go to Connections and click New Connection.
2. Pick PayPal from the marketplace.
3. Enter your credentials (see Authentication above for what's expected).
4. In a workflow, drop an API Call node and select this connection.
5. Pick the operation you need from the Operation dropdown. The full list is below.

Available endpoints

Endpoint	Summary
POST /checkout/orders	Create an order
GET /checkout/orders/{order_id}	Get order details
POST /checkout/orders/{order_id}/capture	Capture payment for an order
POST /payments/captures/{capture_id}/refund	Refund a captured payment
GET /payments/captures/{capture_id}	Get capture details
POST /payments/authorizations/{authorization_id}/capture	Capture an authorized payment

Each endpoint is documented in full below. Use the outline on the right to jump to one.

POST /checkout/orders

Create an order

Detail	Value
Operation ID	payments.createOrder
Method	POST
Path	/checkout/orders

Parameters

No parameters.

Request Body

Field	Type
intent	string
purchase_units	array

Using this endpoint in a workflow

1. Add an API Call node to your workflow.
2. Pick your PayPal connection from the Connection dropdown.
3. In the Operation dropdown, select payments.createOrder.
4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

Required fields are marked: fill them or the call will fail at runtime.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream PayPal API reference.

GET /checkout/orders/{order_id}

Get order details

Detail	Value
Operation ID	payments.getOrder
Method	GET
Path	/checkout/orders/{order_id}

Parameters

Name	Location	Type	Required
order_id	path	string	Yes

Using this endpoint in a workflow

1. Add an API Call node to your workflow.
2. Pick your PayPal connection from the Connection dropdown.
3. In the Operation dropdown, select payments.getOrder.
4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

Required fields are marked: fill them or the call will fail at runtime.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream PayPal API reference.

POST /checkout/orders/{order_id}/capture

Capture payment for an order

Detail	Value
Operation ID	payments.captureOrder
Method	POST
Path	/checkout/orders/{order_id}/capture

Parameters

Name	Location	Type	Required
order_id	path	string	Yes

Using this endpoint in a workflow

1. Add an API Call node to your workflow.
2. Pick your PayPal connection from the Connection dropdown.
3. In the Operation dropdown, select payments.captureOrder.
4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

Required fields are marked: fill them or the call will fail at runtime.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream PayPal API reference.

POST /payments/captures/{capture_id}/refund

Refund a captured payment

Detail	Value
Operation ID	payments.refundCapture
Method	POST
Path	/payments/captures/{capture_id}/refund

Parameters

Name	Location	Type	Required
capture_id	path	string	Yes

Using this endpoint in a workflow

1. Add an API Call node to your workflow.
2. Pick your PayPal connection from the Connection dropdown.
3. In the Operation dropdown, select payments.refundCapture.
4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

Required fields are marked: fill them or the call will fail at runtime.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream PayPal API reference.

GET /payments/captures/{capture_id}

Get capture details

Detail	Value
Operation ID	payments.getCapture
Method	GET
Path	/payments/captures/{capture_id}

Parameters

Name	Location	Type	Required
capture_id	path	string	Yes

Using this endpoint in a workflow

1. Add an API Call node to your workflow.
2. Pick your PayPal connection from the Connection dropdown.
3. In the Operation dropdown, select payments.getCapture.
4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

Required fields are marked: fill them or the call will fail at runtime.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream PayPal API reference.

POST /payments/authorizations/{authorization_id}/capture

Capture an authorized payment

Detail	Value
Operation ID	payments.captureAuthorization
Method	POST
Path	/payments/authorizations/{authorization_id}/capture

Parameters

Name	Location	Type	Required
authorization_id	path	string	Yes

Using this endpoint in a workflow

1. Add an API Call node to your workflow.
2. Pick your PayPal connection from the Connection dropdown.
3. In the Operation dropdown, select payments.captureAuthorization.
4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

Required fields are marked: fill them or the call will fail at runtime.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream PayPal API reference.