Create a payment link

Creates a secure payment link that can be shared with customers to collect payments. The link will contain all necessary payment information and can be used once for the specified amount.

Customer Information

The customer object is optional:

  • With customer info: Payment form is pre-populated for better user experience
  • Without customer info: Customer enters their details during payment process
  • Recommendation: Include customer information when available for higher conversion rates

Payment Link Modes

Standard Mode (default)
  • Customer-facing: Designed for direct customer use
  • Self-service: Customers complete payments independently
  • Full payment methods: All configured payment methods available
  • Interactive features: Supports 3D Secure, digital wallets, etc.
Virtual Terminal Mode
  • Agent-assisted: Designed for staff/agent use rather than end customers
  • Manual processing: Suitable for phone orders and in-person transactions
  • Simplified methods: Payment methods requiring customer interaction are disabled
  • Call center optimized: Streamlined for agent workflows

Use the virtual_terminal_url from the response to access an agent-optimized interface for processing payments using customer data collected over the phone or in person.

Payment Deadline

Use the optional pay_by_utc field to set a deadline for when the payment must be completed. If not provided, the system will automatically set a deadline of 3 days from the time of creation.

Language
Credentials
Bearer
UUID
URL
Click Try It! to start a request and see the response here!