try out ↗

← API Index


/api/client/ppresponse1

Finalize a PayPal payment: shop calls this when the customer returns from the PayPal flow. Confirms or cancels the previously authorized payment.

Change Note: replaces legacy exec1.jsp dispatch for PaypalResponse with POJO pattern

Parameters

Name Description Type
ppresult outcome reported by the shop client: 'confirmed' to finalize, anything else to cancel string
token PayPal token / orderID originally returned by /api/client/ppauthorize string
guid anti-fakery guid (legacy API); '0' for the new SDK flow where the token is the only check string
PayerID PayerID returned by PayPal upon confirmation (legacy API) string
sid session id artificially included in the PayPal callback URL string
oo-rf optionally define the response-format for this call. One of: compact (default) | compacts | full | fulls | json | md | html | js | openapi | yaml String
oo-auth optionally force the API to check against the role (instead of silently not returning data). For guests or public access, the default is -1. 0 (regular customer) and above define the role for which the current session is expected to be authorized. int

Error Responses

HTTP Status Error Code Description
403 security Token/guid mismatch or missing executor - suspected forgery

Response Types

Type Version Description
PaypalResponse 1 Result of a PayPal payment finalization call (invoked after the customer returns from PayPal).

OpenAPI

See ppresponse1.yaml

Referenced in skills