Docs · static mirror — the interactive version loads with JavaScript.

PayPal

Source: https://runstack.engineer/docs/toolkits/paypal

Checkout orders, captures and refunds, payouts, invoicing, and transaction reporting via PayPal REST.

Tools (16):

ToolDescription
paypalCreateOrderCreate a Checkout order (POST /v2/checkout/orders). Set intent CAPTURE or AUTHORIZE and purchase_units with amount/currency.
paypalGetOrderGet a Checkout order by ID (GET /v2/checkout/orders/{orderId}).
paypalPatchOrderPatch a Checkout order (PATCH /v2/checkout/orders/{orderId}) using JSON Patch operations array.
paypalCaptureOrderCapture payment for an approved order (POST /v2/checkout/orders/{orderId}/capture).
paypalAuthorizeOrderAuthorize payment on an order for later capture (POST /v2/checkout/orders/{orderId}/authorize).
paypalGetCaptureGet captured payment details (GET /v2/payments/captures/{captureId}).
paypalRefundCaptureRefund a captured payment fully or partially (POST /v2/payments/captures/{captureId}/refund).
paypalGetRefundGet refund details (GET /v2/payments/refunds/{refundId}).
paypalCreatePayoutCreate a batch payout (POST /v1/payments/payouts). Requires sender_batch_header and items array.
paypalGetPayoutBatchGet payout batch status (GET /v1/payments/payouts/{payoutBatchId}).
paypalGetPayoutItemGet one payout item (GET /v1/payments/payouts-item/{payoutItemId}).
paypalCreateInvoiceCreate a draft invoice (POST /v2/invoicing/invoices). Pass full invoice body.
paypalGetInvoiceGet invoice details (GET /v2/invoicing/invoices/{invoiceId}).
paypalListInvoicesList invoices with optional page filters (GET /v2/invoicing/invoices).
paypalSendInvoiceSend an invoice to recipients (POST /v2/invoicing/invoices/{invoiceId}/send). Optional subject and note.
paypalListTransactionsList account transactions in a time range (GET /v1/reporting/transactions). startDate and endDate are ISO 8601 UTC.