← API Index
/api/client/ppauthorize1
Initiate a PayPal payment authorization. On success returns the PayPal token (orderID for the SDK).
Change Note: replaces legacy exec1.jsp dispatch for DoPaypal with POJO pattern
Parameters
| Name |
Description |
Type |
| total |
PayPal grand total (currency amount) |
double |
| vatsum |
included PayPal total tax |
double |
| shipping |
included PayPal total shipping |
double |
| count |
number of order positions |
int |
| relvoucherid |
relative voucher id to apply to the total (0 if none) |
int |
| 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 |
| 409 |
ERROR |
PayPal authorization could not be initiated (configuration or upstream error) |
Response Types
| Type |
Version |
Description |
| PaypalAuthorize |
1 |
Result of starting a PayPal authorization. On success carries the PayPal token (orderID in the new SDK). |
OpenAPI
See ppauthorize1.yaml
Referenced in skills