Skip to main content
POST
Create order in paypal

Path Parameters

cart_token
string
required

Query Parameters

funding_source
string
required
is_pay_later
boolean
required
expected_total
string

The cart total the client showed the shopper, as a decimal string in the cart currency's major unit ("141.74"). Requires expected_currency. Required for a Fastlane (payment_token_id) or apple_pay order, which is charged at create, while the company's quote-failure policy is enabled: omitting it answers 422 before the cart is repriced. Optional, and ignored, otherwise.

Pattern: ^\d{1,12}(\.\d{1,5})?$
expected_currency
string

ISO 4217 code of the currency the shopper was shown. Requires expected_total.

Response

Created

success
boolean
required
meta
object
required
order_id
string

PayPal order ID returned from create_order. Absent on the vault setup-token shape.

authorization_id
string

Authorization ID, present only on the PayPal Fastlane flow

payment_uuid
string | null

Payment record slug, present only on the PayPal Fastlane flow

setup_token_id
string

PayPal vault setup token, returned instead of order_id for a zero-amount "start free" subscription cart. Send it to Authorize order in paypal after approval.

approve_url
string

PayPal URL where the buyer approves the vault setup token. Returned with setup_token_id.