paypal

Create a PayPal order

Creates a PayPal order for the cart and returns its order_id for the client SDK to approve. Supplying payment_token_id switches the request to the Fastlane capture flow, which additionally returns authorization_id and a payment_uuid — the Fluid payment reference carried into the Cart checkout complete_cart step (POST /api/checkout/v2026-04/carts/{cart_token}/complete, Checkout endpoints reference) as its payment_uuid query parameter. Cart-token authenticated. Returns 422 for invalid parameters, a zero-amount cart, or unsupported recurring Apple Pay; 404 when the cart is not found; and 410 when the cart has already been processed.

POST

/

api

/

payments

/

v2026-04

/

carts

/

{cart_token}

/

paypal

/

orders

curl --request POST \
  --url https://api.fluid.app/api/payments/v2026-04/carts/{cart_token}/paypal/orders \
  --header 'Content-Type: application/json' \
  --data '
{
  "funding_source": "paypal",
  "is_pay_later": false
}
'

{
  "success": true,
  "order_id": "5O190127TN364715T",
  "meta": {
    "request_id": "018f2c1a-8b3a-7e6d-9f10-2a3b4c5d6e7f",
    "timestamp": "2026-04-01T12:00:00Z"
  }
}

{
  "error_message": "<string>",
  "errors": "<string>",
  "meta": {
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z"
  }
}

{
  "error_message": "<string>",
  "errors": "<string>",
  "meta": {
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z",
    "shop_url": "<string>",
    "cart": {}
  }
}

{
  "error_message": "<string>",
  "errors": "<string>",
  "meta": {
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z"
  }
}

Path Parameters

cart_token

string

required

Opaque cart token returned by the create-cart response. It scopes the request to a single cart and is the credential for these endpoints — cart-token authentication carried in the path, with no bearer token or API key.

Body

application/json

funding_source

string

required

PayPal funding source (e.g. paypal, Venmo, apple_pay).

is_pay_later

boolean

required

payment_token_id

string

Fastlane single-use payment token; presence switches the order to the Fastlane capture flow.

is_app_switch

boolean

Response

Order created

Success body for PayPal order creation. authorization_id and payment_uuid are present only for Fastlane orders (when payment_token_id is supplied).

success

boolean

required

true when the PayPal order was created.

order_id

string

required

PayPal order id; pass it to the client SDK to approve, then to the authorize endpoint.

meta

object

required

Standard response metadata included on every response.

Show child attributes

authorization_id

string

PayPal capture id (Fastlane orders only).

payment_uuid

string

Fluid payment reference (slug), returned for Fastlane orders only. This is the reference the Cart checkout complete_cart step (POST /api/checkout/v2026-04/carts/{cart_token}/complete, Checkout endpoints reference) consumes as its payment_uuid query parameter.

Get PayPal client SDK token

Authorize a PayPal order

curl --request POST \
  --url https://api.fluid.app/api/payments/v2026-04/carts/{cart_token}/paypal/orders \
  --header 'Content-Type: application/json' \
  --data '
{
  "funding_source": "paypal",
  "is_pay_later": false
}
'

{
  "success": true,
  "order_id": "5O190127TN364715T",
  "meta": {
    "request_id": "018f2c1a-8b3a-7e6d-9f10-2a3b4c5d6e7f",
    "timestamp": "2026-04-01T12:00:00Z"
  }
}

{
  "error_message": "<string>",
  "errors": "<string>",
  "meta": {
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z"
  }
}

{
  "error_message": "<string>",
  "errors": "<string>",
  "meta": {
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z",
    "shop_url": "<string>",
    "cart": {}
  }
}

{
  "error_message": "<string>",
  "errors": "<string>",
  "meta": {
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z"
  }
}