commerce
POST /v1/orders/{orderId}/paypal
Open a PayPal order for the browser to complete.
Authentication
Send an API key as a bearer token. This endpoint does not state a specific permission in the specification, so give your key the least it needs and check the response rather than assuming.
This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.
Try it
Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.
curl -X POST https://api.zinndigital.com/v1/orders/{orderId}/paypal \
-H "Authorization: Bearer zdk_live_…"Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console
Details
Returns the PayPal order id the JS SDK attaches to. The order carries no `payment_source`, so it is open to **either** rail — the PayPal wallet via Buttons, or a card entered into PayPal's hosted Advanced card fields — and the buyer's choice in the browser decides which. Idempotent per Zinn® order: reloading the checkout page returns the same PayPal order rather than opening a second one.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
orderId (path) | Uuid | Yes | The order's id. |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
paypal_order_id | string | Yes | PayPal's order id, for `createOrder` in the JS SDK. |
Errors this endpoint can return
401 · 403 · 404 · 422 · 429 · 503