Paypal Payments
PayPal Payments is a PayPal API for processing and managing payment transactions through PayPal.
- Base URL:
https://api-m.paypal.com - Auth: OAuth 2.0 client-credentials — the tool fetches a token from
https://api-m.paypal.com/v1/oauth2/tokenusing yourclientId/clientSecret, then calls the API.
Operations
authorizations_get— GET /v2/payments/authorizations/{authorization_id} — Show details for authorized paymentcaptures_get— GET /v2/payments/captures/{capture_id} — Show captured payment detailsrefunds_get— GET /v2/payments/refunds/{refund_id} — Show refund detailsauthorizations_capture— POST /v2/payments/authorizations/{authorization_id}/capture — Capture authorized paymentauthorizations_reauthorize— POST /v2/payments/authorizations/{authorization_id}/reauthorize — Reauthorize authorized paymentauthorizations_void— POST /v2/payments/authorizations/{authorization_id}/void — Void authorized payment
Inputs
clientId/clientSecret— your paypal-payments OAuth app credentialsscope— OAuth scopes (optional; defaults from the spec)operation— one of the operations above- path parameters when an operation's path contains
{...} query— optional JSON object of query paramsbody— JSON object for create/update ops
Example
operation: authorizations_get
clientId: <your client id>
clientSecret: <your client secret>
Publishes
The keys a later task may reference as {{taskName.key}}. Referencing anything not listed here resolves to nothing at run time.
erroroperationresultstatus
Input Properties
Every property this tool accepts, from its own tool.iml.
| Property | Type | Required | Default | Description |
|---|---|---|---|---|
clientId |
string | yes | — | OAuth client ID for paypal-payments. |
clientSecret |
string | yes | — | OAuth client secret for paypal-payments. |
operation |
string | yes | — | One of: authorizations_get, captures_get, refunds_get, authorizations_capture, authorizations_reauthorize, authorizations_void |
scope |
string | no | https://uri.paypal.com/services/payments/payment/authcapture https://uri.paypal.com/services/payments/refund https://uri.paypal.com/services/payments/non-referenced-credit https://uri.paypal.com/services/payments/realtimepayment https://uri.paypal.com/services/payments/reversepayment https://uri.paypal.com/services/payments/payments-ready Braintree:PaymentsReady https://uri.paypal.com/services/payments/client-payments-eligibility |
OAuth scopes (space-separated); default from the spec. |
authorization_id |
string | no | — | Path parameter authorization_id (required by some operations). |
capture_id |
string | no | — | Path parameter capture_id (required by some operations). |
refund_id |
string | no | — | Path parameter refund_id (required by some operations). |
body |
string | no | — | Request body as a JSON object string (for create/update operations). |
query |
string | no | — | Query-string parameters as a JSON object string, e.g. {"limit": 50}. Parsed and url-encoded onto the request. |