Skip to main content
POST
Authorize order in paypal

Path Parameters

cart_token
string
required

Body

application/json

Request payload

order_id
string
required

PayPal order ID returned from create_order, to be authorized. Not needed on the zero-amount vault path, which sends setup_token_id instead.

setup_token_id
string

Approved PayPal vault setup token from create_order. Only read for a zero-amount "start free" subscription cart.

expected_total
string

The total the client showed the shopper, as a fixed-point decimal string in the currency's major unit. Optional; must be sent with expected_currency.

expected_currency
string

ISO 4217 code of expected_total. Optional; must be sent with expected_total.

Response

Success

meta
object
required
success
boolean
required
authorization_id
string

PayPal authorization id. Returned on the charge path.

authorized_total
object

The amount PayPal now holds for this order. Omitted when PayPal's response carried no readable amount.

order_id
string

PayPal order id that was authorized. Returned on the charge path.

payment_method_id
integer

Id of the reusable PayPal payment method attached to the cart. Returned only on the zero-amount vault path, in place of order_id and authorization_id.