# Create Link

## /payLinks/api

<mark style="color:green;">`POST`</mark> `https://paymentlink.seerbitapi.com/paymentlink/v2/payLinks/api`

This enpoint allows you create payment links

#### Headers

| Name                                            | Type   | Description  |
| ----------------------------------------------- | ------ | ------------ |
| Authorization<mark style="color:red;">\*</mark> | String | Bearer Token |

#### Request Body

| Name                                               | Type   | Description                                                                                               |
| -------------------------------------------------- | ------ | --------------------------------------------------------------------------------------------------------- |
| Status<mark style="color:red;">\*</mark>           | String | link status - (ACTIVE, INACTIVE)                                                                          |
| paymentLinkName<mark style="color:red;">\*</mark>  | String | name of the link                                                                                          |
| description<mark style="color:red;">\*</mark>      | String | decription of this page                                                                                   |
| currency<mark style="color:red;">\*</mark>         | String | The transaction currency (NGN, GHS, KES,XOF or USD). Country Default currency must be passed              |
| successMessage                                     | String | Custom message to show customers after a successful payment                                               |
| publicKey<mark style="color:red;">\*</mark>        | String | merchant publickey                                                                                        |
| customisationName                                  | String | unique url extension for payment link                                                                     |
| paymentFrequency<mark style="color:red;">\*</mark> | String | ONE-TIME or RECURRENT                                                                                     |
| paymentReference                                   | String |                                                                                                           |
| email                                              | String |                                                                                                           |
| additionalData                                     | String | additional data for payments                                                                              |
| linkExpirable<mark style="color:red;">\*</mark>    | String | set true or false                                                                                         |
| expiryDate                                         | String | set date                                                                                                  |
| oneTime<mark style="color:red;">\*</mark>          | String | set true if you want the link to be used once or set false if you want the link to be used multiple times |
| address                                            | String | true or false if you need to collect customer address                                                     |
| amount<mark style="color:red;">\*</mark>           | String | true or false                                                                                             |
| customerName<mark style="color:red;">\*</mark>     | String | true                                                                                                      |
| mobileNumber<mark style="color:red;">\*</mark>     | String | true or false if you need to collect customer number                                                      |
| invoiceNumber                                      | String | true or false if you need to collect invoice number                                                       |

{% tabs %}
{% tab title="cURL" %}

```javascript
curl --location 'https://paymentlink.seerbitapi.com/paymentlink/v2/payLinks/api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR_ENCRYPTED_KEY' \
--data-raw '{
  "status":"ACTIVE",
  "paymentLinkName": "Donations",
  "description":"Give out donations",
  "currency": "NGN",
  "successMessage":"Thank you for your payment",
  "publicKey":"YOUR_PUBLIC_KEY",
 "customizationName":"testing1",
  "paymentFrequency":"ONE_TIME",
  "paymentReference": "",  
  "email":"js@emaildomain.com",
  "requiredFields": {
      "address":true,
      "amount":true,
      "customerName":false,
      "mobileNumber":true,
      "invoiceNumber":false
  },
  "additionalData":"Customer Email: js@mailinator.com", 
  "linkExpirable":false,
  "expiryDate":"",
  "oneTime":false

}'

```

{% endtab %}

{% tab title="200: OK Link Successfully Created" %}

```javascript
{
    "data": {
        "paymentLinks": {
            "publicKey": "SBPUBK_******************PHI",
            "status": "ACTIVE",
            "additionalData": "custom1:null||custom2:null||custom3:null",
            "paymentLinkName": "Donationas",
            "description": "Donation",
            "successMessage": "Payment made successfully!",
            "paymentLinkId": "000000000",
            "currency": "NGN",
            "paymentReference": ""  // optional,
            "paymentFrequency": "RECURRENT",
            "paymentLinkUrl": "https://pay.seerbitapi.com/paymentLinkId",
            "customizationName": "utbesti22",
            "environment": "LIVE",
            "requiredFields": {
                "address": true,
                "amount": true,
                "customerName": true,
                "mobileNumber": true,
                "invoiceNumber": false
            },
            "expiryDuration": 0,
            "linkExpirable": false,
            "createdAt": "2021-09-21T10:49:17.728",
            "updatedAt": "2021-09-21T10:49:17.728",
            "oneTime": false,
            "splitPayment": false
        }
    }
}
```

{% endtab %}
{% endtabs %}