Create Payment Link

POST https://paylinks.uqualify.co.uk/api/v1/paylinks

The Create Payment Link endpoint enables you to generate a new payment link for a specific product or service within the Uqualify platform. This link can be customized with various parameters, such as the amount, currency, and description, facilitating payments for a wide range of offerings. Use this endpoint to quickly create payment links you can share with customers to collect payments seamlessly.

info

When creating a payment link, you can implicitly create a plan by providing details such as amount and currency.

Body Parameters

Parameter	Type	Description
amount	string	The amount associated with the payment link.
currency	string	The currency of the payment link.
description	string	A description of the payment link.
interval	string	The recurring interval for the payment link: Week, Month, Year.
intervalCount	integer	The number of intervals for the recurring payment link.
metadata	object	Additional metadata associated with the payment link.
name	string	The name of the payment link.
reference	string	The reference for the payment link.
trial_period	string	The trial period for the payment link in a valid duration format (e.g., 24h).
type	string	The type of the plan: 1 = Unknown, 2 = Onetime

Example Request

curl --request POST \
     --url https://paylinks.uqualify.co.uk/api/v1/paylinks \
     --header 'X-API-KEY: API-KEY' \
     --header 'accept: application/json' \
     --header 'content-type: application/json'

Responses

200

info

To generate a payment link, simply append the payment ID to the following base URL:

pay.boomfi.xyz

For example, if the payment ID is 2m2EcPjK0GACD29VHRHvduBKsAd, the final payment link would be:

pay.boomfi.xyz/2m2EcPjK0GACD29VHRHvduBKsAd

Field	Type	Description
data	object	The data object containing the paylinks.
data.id	string	The unique identifier for the paylink.
data.plan_id	string	The ID of the associated plan.
data.invoice_id	string	The ID of the associated invoice.
data.source	string	The source of the paylink.
data.customer_ident_collection	boolean	Indicates if customer identification collection is enabled.
data.shipping_address_collection	boolean	Indicates if shipping address collection is enabled.
data.tax_ident_collection	boolean	Indicates if tax identification collection is enabled.
data.enabled	boolean	Indicates if the paylink is enabled.
data.deleted_at	date-time	The timestamp when the paylink was deleted.
data.created_by	string	The ID of the user who created the paylink.
data.updated_by	string	The ID of the user who last updated the paylink.
data.created_at	date-time	The timestamp when the paylink was created.
data.updated_at	date-time	The timestamp when the paylink was last updated.
data.metadata	object	Additional metadata associated with the paylink.
data.metadata.properties	object	Additional properties associated with the paylink.
data.plan	object	The details of the associated plan.
error	boolean	Indicates if there was an error.

{
  "data": {
    "id": "2Z4zsnmp37AF3WKM6N2j4wmeakr",
    "plan_id": "2Z4zspFMhs2pMYjcR3l6JpJaWdA",
    "invoice_id": "",
    "source": "BoomFi",
    "customer_ident_collection": false,
    "shipping_address_collection": false,
    "tax_ident_collection": false,
    "enabled": true,
    "deleted_at": "2023-12-04T13:25:48.499Z",
    "created_by": "2TzGhPCAfFWLPBjtc6h52Aao2S6",
    "updated_by": "",
    "created_at": "2023-12-04T13:25:48.496Z",
    "updated_at": "2023-12-04T13:25:48.499Z",
    "metadata": {},
    "properties": {
      "short_code": "AANj9Dm7Zl"
    },
    "plan": {
      "id": "2Z4zspFMhs2pMYjcR3l6JpJaWdA",
      "org_id": "2Tpmnmh6GHJXumKN1oBy2u56Ima",
      "source": "Lago",
      "name": "test paylink 12 04",
      "type": "OneTime",
      "billing_scheme": "FlatFee",
      "price": "1",
      "currency": "USD",
      "available_quantity": 0,
      "trial_period": "",
      "recurring_interval": "Unknown",
      "recurring_interval_count": 1,
      "recurring_usage_type": "Unknown",
      "reference": "",
      "enabled": true,
      "v1": "eyJwbGFucyI6IHsiaWQiOiAiYWE1ZmI5MjQtMmMzZi00NzcwLTkyZDEtMjFjYmY3ODc3ODc2IiwgIm5hbWUiOiAidGVzdCBwYXlsaW5rIDEyIDA0IiwgInN0YXR1cyI6ICJhY3RpdmUiLCAiaW50ZXJ2YWwiOiBudWxsLCAicmVmZXJlbmNlIjogIiIsICJhbW91bnRfd2VpIjogIjEwMCIsICJjcmVhdGVkX2F0IjogIjIwMjMtMTI...",
      "created_by": "2TzGhPCAfFWLPBjtc6h52Aao2S6",
      "created_at": "2023-12-04T13:25:47.656Z",
      "updated_at": "2023-12-04T13:25:48.491Z",
      "deleted_at": null,
      "metadata": {}
    }
  },
  "error": true
}

400

Field	Type	Description	Example
error	object	The error returned by the server.
error.code	integer	The error code returned by the server.	400
error.errors	array of objects	A list of detailed error objects.
error.errors.domain	string	The domain associated with the error.	orders
error.errors.reason	string	The reason for the error.	InsufficientQuantity
error.message	string	A descriptive message explaining the error.	Insufficient quantity

{
  "error": {
    "code": 400,
    "errors": [
      {
        "domain": "orders",
        "reason": "InsufficientQuantity"
      }
    ],
    "message": "Insufficient quantity"
  }
}

500

Field	Type	Description	Example
error	object	The error returned by the server.
error.code	integer	The error code returned by the server.	500
error.errors	array of objects	A list of detailed error objects.
error.errors.domain	string	The domain associated with the error.	orders
error.errors.reason	string	The reason for the error.	Internal
error.message	string	A descriptive message explaining the error.	Internal server error

{
  "error": {
    "code": 500,
    "errors": [
      {
        "domain": "orders",
        "reason": "Internal"
      }
    ],
    "message": "Internal server error"
  }
}