This endpoint allows you to create a payment link with the specified details.
Key | Required | Type | Description |
---|---|---|---|
name | true | string (max: 250) | The name of the payment link. |
description | false | string (max: 250) | A description of the payment link. |
slug | false | string (max: 250) | A unique identifier (URL-friendly). Must match regex: ^[a-zA-Z0-9-]+$ . |
amount | false | string | The amount for the payment link. Must be a valid string number > 0. |
redirectUrl | false | string (URL) | The URL to redirect the user after payment. Must include http:// or https:// . |
successMessage | false | string (max: 500) | Message shown when the payment succeeds. |
inactiveMessage | false | string (max: 500) | Message shown when the payment link is inactive. |
metadata | false | object (JSON string) | Custom metadata as key-value pairs (string or number ). Must be sent as a JSON string in form-data. |
paymentLimit | false | number (min: 1) | Maximum number of payments allowed for this link. |
file | false | file | An optional file upload (e.g., image or document) attached to the payment link. |
200
The response is of type object
.