Payment Links
Overview
A Payment link is used to collect payments from your customers. You can send a payment link to your customers via email, SMS, WhatsApp, or any other messaging app. When your customer clicks on the link, they will be redirected to a payment page where they can complete the payment.
The Payment Link Data Model simplifies the handling and retrieval of Payment Link data for your application. The model provides a unified representation of payment link data across different platforms, enabling you to easily access and manage payment link data from different platforms.
- Unified Payment Link properties: The model provides a unified representation of payment link properties across different platforms, enabling you to easily access and manage payment links data from different platforms.
- Comprehensive payment links information: The model provides a comprehensive representation of payment link data, including all the properties and relationships that you can retrieve for an order.
Properties Supported
| Property | Type | Description |
|---|---|---|
| platform_id | string | The Platform’s ID for the Payment Link |
| description | string | The description of the Payment Link |
| created_at | string | The date the Payment Link was created |
| updated_at | string | The date the Payment Link was updated |
| amount | string | The amount of the Payment Link |
| currency_id | string | The currency of the Payment Link |
| link | string | The link of the Payment Link |
| status | string | The status of the Payment Link. Allowed values are ACTIVE, INACTIVE |
| line_items | object[] | The line items of the Payment Link |