v1

latestOpenAPI 3.0.02026-07-243678114.1 KB

Paylinks

Create Variant Pay Link URL

The Create Variant Pay Link URL endpoint enables you to create a customized version of an existing payment link, allowing you to modify key elements such as the amount and currency. This functionality is ideal for scenarios where you need to offer personalized payment options, such as discounts, special pricing, or promotions, while maintaining the original plan’s integrity.

📘 Note

You can use this endpoint to offer discounts or custom pricing by creating a variant of an existing paylink.

get/v1/paylinks/generate-variant/{paylinkId}

Path parameters

paylinkIdstring required

Unique identifier of the payment link.

Query parameters

amountstring

Amount to be associated with the payment link variant.

currencystring

Currency to be associated with the payment link variant.

customer_identstring

Customer identifier to record as customer.reference.

redirect_tostring

URL to redirect customer after a successful payment.

Response

urlstring

The URL of the paylink variant

created_bystring

The ID of the user who created the paylink variant

Example response

{
  "url": "https://pay-test.boomfi.xyz/2Z4zsnmp37AF3WKM6N2j4wmeakr?amount=101&currency=EUR&signature=7a3043f809aa4aab4ca68694f9394c6fe4deb82c745347a4fc4ae33f6716c22e",
  "created_by": "2TzGhPCAfFWLPBjtc6h52Aao2S6",
  "payment_link": {
    "id": "2Z4zsnmp37AF3WKM6N2j4wmeakr",
    "plan_id": "2Z4zspFMhs2pMYjcR3l6JpJaWdA",
    "source": "BoomFi",
    "enabled": true,
    "deleted_at": "2023-12-04T13:25:48.499Z",
    "created_by": "2TzGhPCAfFWLPBjtc6h52Aao2S6",
    "created_at": "2023-12-04T13:25:48.496Z",
    "updated_at": "2023-12-04T13:25:48.499Z",
    "expires_at": "2026-12-31T23:59:59Z",
    "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",
      "recurring_interval": "Unknown",
      "recurring_interval_count": 1,
      "recurring_usage_type": "Unknown",
      "enabled": true,
      "v1": "eyJwbGFucyI6IHsiaWQiOiAiYWE1ZmI5MjQtMmMzZi00NzcwLTkyZDEtMjFjYmY3ODc3ODc2IiwgIm5hbWUiOiAidGVzdCBwYXlsaW5rIDEyIDA0IiwgInN0YXR1cyI6ICJhY3RpdmUiLCAiaW50ZXJ2YWwiOiBudWxsLCAicmVmZXJlbmNlIjogIiIsICJhbW91bnRfd2VpIjogIjEwMCIsICJjcmVhdGVkX2F0IjogIjIwMjMtMTI...",
      "created_by": "2TzGhPCAfFWLPBjtc6h52Aao2S6",
      "created_at": "2023-12-04T13:25:47.656Z",
      "updated_at": "2023-12-04T13:25:48.491Z",
      "metadata": {}
    }
  },
  "plan": {
    "id": "2eJh1L1rDrCZxTyE6vwGhck7LWI",
    "org_id": "2Tpmnmh6GHJXumKN1oBy2u56Ima",
    "metadata": {
      "key": "value"
    },
    "properties": {
      "key": "value"
    }
  }
}