Create Payment Request PayPal Pay Link
POST/api/sales-payment-requests/:salesPaymentRequestId/paypal-payment-links
Create a PayPal pay link collecting a payment request. The link is raised on the request's sales order (replacing that order's active link), so the captured payment lands on the order and pays the request. amount defaults to the request's balance and can't exceed it.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
Requires permission sales_payment_requests.send.
Body fields:
amount(number, optional, ≥ 0.01)integration_instance_id(integer, required — the PayPal account)expires_in_days(integer, optional, 1–365, default 30)email_customer(boolean, optional — email the link with the PayPal payment request template)recipient_email(string email, optional)cc(array of emails, optional, max 10)
Request
Responses
- 201
- 401
- 403
- 404
- 422
- 429
Created
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Not Found
Response Headers
Unprocessable Entity
Response Headers
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.