Actions9
Payment Link → Create
AI-generatedSummary
Create a payment link for a specified payer with defined payment details and configuration options.
Inputs
- Amount (required) — The payment amount in cents for the payment link.
- Payer ID (required) — Identifier of the payer the payment link is created for.
- Description (required) — Description of the payment shown on the payment link page.
- Return Url (required) — URL to redirect the payer after payment completion; will include paymentLinkId and paymentId parameters.
- Currency — Currency for the payment; defaults to the merchant's currency if not specified.
- Link Expiry Date — DateTime when the payment link should expire.
- Allowed Payment Methods (required) — Payment methods permitted for this link; options are 'credit-card' and 'bank-account'.
- Surcharged Payment Methods — Payment methods that will have surcharging applied; options include 'credit-card' and 'bank-account'.
- Metadata — Additional metadata to attach to the payment link.
Output shape
a single record
The operation returns the created payment link object as JSON, including its ID and details.
Examples
Example 1: Create a payment link with minimum required parameters
Provide amount, payer ID, description, return URL, and allowed payment methods.