# Orders API

> Orders API on Apizie: 9 endpoints (Create order, Show order details, Update order, Confirm the Order, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://apizie.tech/v1/payments:paypal-orders/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `payments:paypal-orders`
- Category: Payments
- Status: byok
- Source: https://paypal
- Page: https://apizie.tech/api/payments/paypal-orders
- OpenAPI: https://apizie.tech/api/payments/paypal-orders/openapi.json

An order represents a payment between two or more parties. Use the Orders API to create, update, retrieve, authorize, and capture orders.

## Endpoints

### Create order
`POST https://apizie.tech/v1/payments:paypal-orders/orders-create` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| PayPal-Request-Id | string | no | The server stores keys for 6 hours. The API callers can request the times to up to 72 hours by speaking to their Account Manager. It is… |
| PayPal-Partner-Attribution-Id | string | no | PayPal Partner can send a PayPal-Partner-Attribution-Id request header with the value that they have been assigned by the PayPal Partner… |
| PayPal-Client-Metadata-Id | string | no | A GUID value originating from Fraudnet and Dyson passed from external API clients via HTTP header. The value is used by Risk decisions to… |
| Prefer | string | no | The preferred server response upon successful completion of the request. Value is: return=minimal . The server returns a minimal response… |
| PayPal-Auth-Assertion | string | no | Header for an API client-provided JWT assertion that identifies the merchant. Establishing the consent to act-on-behalf of a merchant is a… |
| body | object | yes | JSON request body |

### Show order details
`GET https://apizie.tech/v1/payments:paypal-orders/orders-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | The ID of the order for which to show details. |
| PayPal-Auth-Assertion | string | no | Header for an API client-provided JWT assertion that identifies the merchant. Establishing the consent to act-on-behalf of a merchant is a… |
| fields | string | no | A comma-separated list of fields that should be returned for the order. Valid filter field is `payment_source`. |

### Update order
`POST https://apizie.tech/v1/payments:paypal-orders/orders-patch` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | The ID of the order to update. |
| PayPal-Auth-Assertion | string | no | Header for an API client-provided JWT assertion that identifies the merchant. Establishing the consent to act-on-behalf of a merchant is a… |
| body | object | no | JSON request body |

### Confirm the Order
`POST https://apizie.tech/v1/payments:paypal-orders/orders-confirm` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| PayPal-Client-Metadata-Id | string | no | A GUID value originating from Fraudnet and Dyson passed from external API clients via HTTP header. The value is used by Risk decisions to… |
| id | string | yes | The ID of the order for which the payer confirms their intent to pay. |
| PayPal-Auth-Assertion | string | no | Header for an API client-provided JWT assertion that identifies the merchant. Establishing the consent to act-on-behalf of a merchant is a… |
| Prefer | string | no | The preferred server response upon successful completion of the request. Value is: return=minimal . The server returns a minimal response… |
| body | object | no | JSON request body |

### Authorize payment for order
`POST https://apizie.tech/v1/payments:paypal-orders/orders-authorize` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| PayPal-Request-Id | string | no | The server stores keys for 6 hours. The API callers can request the times to up to 72 hours by speaking to their Account Manager. It is… |
| Prefer | string | no | The preferred server response upon successful completion of the request. Value is: return=minimal . The server returns a minimal response… |
| PayPal-Client-Metadata-Id | string | no | A GUID value originating from Fraudnet and Dyson passed from external API clients via HTTP header. The value is used by Risk decisions to… |
| id | string | yes | The ID of the order for which to authorize. |
| PayPal-Auth-Assertion | string | no | Header for an API client-provided JWT assertion that identifies the merchant. Establishing the consent to act-on-behalf of a merchant is a… |
| body | object | no | JSON request body |

### Capture payment for order
`POST https://apizie.tech/v1/payments:paypal-orders/orders-capture` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| PayPal-Request-Id | string | no | The server stores keys for 6 hours. The API callers can request the times to up to 72 hours by speaking to their Account Manager. It is… |
| Prefer | string | no | The preferred server response upon successful completion of the request. Value is: return=minimal . The server returns a minimal response… |
| PayPal-Client-Metadata-Id | string | no | A GUID value originating from Fraudnet and Dyson passed from external API clients via HTTP header. The value is used by Risk decisions to… |
| id | string | yes | The ID of the order for which to capture a payment. |
| PayPal-Auth-Assertion | string | no | Header for an API client-provided JWT assertion that identifies the merchant. Establishing the consent to act-on-behalf of a merchant is a… |
| body | object | no | JSON request body |

### Add tracking information for an Order.
`POST https://apizie.tech/v1/payments:paypal-orders/orders-track-create` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | The ID of the order that the tracking information is associated with. |
| PayPal-Auth-Assertion | string | no | Header for an API client-provided JWT assertion that identifies the merchant. Establishing the consent to act-on-behalf of a merchant is a… |
| body | object | yes | JSON request body |

### Update or cancel tracking information for an order
`POST https://apizie.tech/v1/payments:paypal-orders/orders-trackers-patch` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | The ID of the order that the tracking information is associated with. |
| tracker_id | string | yes | The order tracking ID. |
| PayPal-Auth-Assertion | string | no | Header for an API client-provided JWT assertion that identifies the merchant. Establishing the consent to act-on-behalf of a merchant is a… |
| body | object | no | JSON request body |

### Receive updated order information via callback URL
`POST https://apizie.tech/v1/payments:paypal-orders/server-callback` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

## Example
```
curl "https://apizie.tech/v1/payments:paypal-orders/orders-create" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Orders API?
Create a free Apizie key, then send POST https://apizie.tech/v1/payments:paypal-orders/orders-create with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Orders API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Orders itself also needs your own key from paypal.

### Can AI agents use the Orders API?
Yes. Add the Apizie MCP server (https://apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key payments:paypal-orders.

### What is the status of the Orders API?
Needs your own provider key (bring your own key)