> For the complete documentation index, see [llms.txt](https://konnadex-docs.gitbook.io/konnadex-technologies/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://konnadex-docs.gitbook.io/konnadex-technologies/payments/payment-links/standard-payment.md).

# 🔗 Standard Payment

Introduction

Standard payment links are shareable links that you can use to receive digital payments from your customers worldwide

#### Create a new standard payment Link <a href="#create-a-new-standard-payment-link" id="create-a-new-standard-payment-link"></a>

Use this end-point to create a new standard payment link

### Create a new standard payment link with cart or without a cart <a href="#create-a-new-standard-payment-link-with-cart-or-without-a-cart" id="create-a-new-standard-payment-link-with-cart-or-without-a-cart"></a>

`POST` `https://api.konnadex.com/v1/payment-link`

Request Body

<table><thead><tr><th width="119.66668701171875">Name</th><th width="109.6666259765625">Type</th><th>Description</th></tr></thead><tbody><tr><td>action*</td><td>String</td><td><p>"action":</p><p>{"fiatAmount" :1000, "linkType": "Standard" , "title": "Frank", "description": "Frank wedding contribution", "action": {"successMessage":"Thanks for Paying for Frank's wedding", "redirectURL": "https://www.hope.com/", "redirect": true, "showConfirmationPage": false}}</p></td></tr><tr><td>options*</td><td>String</td><td>"options":{"collectAddress":true,"collectPhone":true},</td></tr><tr><td>description*</td><td>String</td><td>"description": "Donation for Frank's wedding",</td></tr><tr><td>title*</td><td>String</td><td>"Frank wedding contribution",</td></tr><tr><td>fiatCurrency</td><td>String</td><td>"NGN"</td></tr><tr><td>cart*</td><td>String</td><td>"cart":{"items":[]},"fiatCurrency":"NGN", "fiatAmount":1000,}</td></tr><tr><td>fiatAmount</td><td>Number</td><td>This is the amount your customer is expected to pay</td></tr><tr><td>linkType</td><td>String</td><td>Standard</td></tr></tbody></table>

201: Created Create with Cart  &#x20;

```javascript
{
    "slug": "kvAumFXNcM",
    "url": "https://konnadex-paylink.vercel.app/kvAumFXNcM",
    "title": "ELECTION-DONATION",
    "linkType": "Standard",
    "description": "Donation for presidential election",
    "userId": "65f8eaf707dc84c6235c2796",
    "integratorId": "65f8eaf707dc84c6235c2798",
    "fiatAmount": "50",
    "fiatCurrency": ["NGN","USD","EUR","GBP","GHS","AUD","JPY"]
    "prepayOptions": {
        "collectAddress": true,
        "collectPhone": true
    },
    "postpayAction": {
        "redirect": true,
        "showConfirmationPage": true,
        "successMessage": "Thank you for your payment",
        "redirectUrl": "https://www.konna.io/"
    },
    "cart": {
        "items": []
    },
    "createdAt": "2024-03-20T12:21:32.388Z",
    "updatedAt": "2024-03-20T12:21:32.388Z",
    "deletedAt": null,
    "id": "e0e26ec8-30c0-4a21-8fb9-ad116ced793d",
    "isActive": true,
    "visitedCount": 0,
    "paymentCount": 0
}
```

#### Example : cURL <a href="#example-curl" id="example-curl"></a>

```javascript
curl --request POST \
     --url https://api.konnadex.com/v1/payment-link \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
{
  "linkType": "DONATION",
  "fiatCurrency": ["NGN","USD","EUR","GBP","GHS","AUD","JPY"],
  "options": {
    "collectAddress": true,
    "collectPhone": true
  },
  "action": {
    "redirect": true,
    "showConfirmationPage": true
  }
}
'
```

#### Update an existing standard payment Link <a href="#update-an-existing-standard-payment-link" id="update-an-existing-standard-payment-link"></a>

Use this end-point to update an existing standard payment link

### Update a standard payment link with cart or without cart <a href="#update-a-standard-payment-link-with-cart-or-without-cart" id="update-a-standard-payment-link-with-cart-or-without-cart"></a>

`PATCH` `https://api.konnadex.com/v1/payment-link`

**Request Body**

<table><thead><tr><th width="132.6666259765625">Name</th><th width="127.66668701171875">Type</th><th>Description</th></tr></thead><tbody><tr><td><p>action*</p><p><br></p></td><td>String</td><td><p>"action":</p><p>{"redirect":true,"showConfirmationPage":true,"successMessage":"Thank you for your payment","redirectUrl":"<a href="https://www.konna.io/">https://www.konna.io/</a>"},"isActive":true},</p></td></tr><tr><td>options*</td><td>String</td><td>{"collectAddress":true,"collectPhone":true},</td></tr><tr><td>description*</td><td>String</td><td>"Donation for presidential election",</td></tr><tr><td>title*</td><td>String</td><td>"ELECTION-DONATION",</td></tr><tr><td>cart*</td><td>String</td><td>{"items":[]},"fiatCurrency":"NGN","fiatAmount":50,</td></tr><tr><td>fiatAmount</td><td>Number</td><td>This is the amount your customer is expected to pay</td></tr><tr><td>linkType</td><td>String</td><td>Standard link</td></tr></tbody></table>

200: OK Update with Cart   200: OK Update with ChargeCopy

```javascript
// Some code{
    "slug": "kvAumFXNcM",
    "url": "https://konnadex-paylink.vercel.app/kvAumFXNcM",
    "title": "ELECTION-DONATION",
    "linkType": "Standard",
    "description": "Donation for presidential election",
    "userId": "65f8eaf707dc84c6235c2796",
    "integratorId": "65f8eaf707dc84c6235c2798",
    "fiatAmount": "50",
    "fiatCurrency": ["NGN","USD","EUR","GBP","GHS","AUD","JPY"]
    "prepayOptions": {
        "collectAddress": true,
        "collectPhone": true
    },
    "postpayAction": {
        "redirect": true,
        "showConfirmationPage": true,
        "successMessage": "Thank you for your payment",
        "redirectUrl": "https://www.konna.io/"
    },
    "cart": {
        "items": []
    },
    "createdAt": "2024-03-20T12:21:32.388Z",
    "updatedAt": "2024-03-20T12:21:32.388Z",
    "deletedAt": null,
    "id": "e0e26ec8-30c0-4a21-8fb9-ad116ced793d",
    "isActive": true,
    "visitedCount": 0,
    "paymentCount": 0
}
```

### Get a standard payment link with cart or without cart <a href="#get-a-standard-payment-link-with-cart-or-without-cart" id="get-a-standard-payment-link-with-cart-or-without-cart"></a>

`GET` `https://api.konnadex.com/v1/payment-link`

200: OK Update with Cart200: OK Update with ChargeCopy

```javascript
// {
  "items": [
    {
      "createdAt": "2024-03-17T21:40:33.486Z",
      "updatedAt": "2024-03-18T16:48:43.782Z",
      "deletedAt": null,
      "id": "a18435f3-3f75-47f9-87ee-e4a75cadff51",
      "slug": "jqlRoHmqem",
      "url": "https://konnadex-paylink.vercel.app/jqlRoHmqem",
      "isActive": true,
      "visitedCount": 5,
      "paymentCount": 0,
      "linkType": "Standard",
      "title": "PAYMENT-CASTRO-MARRIAGE",
      "description": "Payment for castro marriage",
      "userId": "651298c28a73710b161bda6e",
      "integratorId": "651298c28a73710b161bda70",
      "fiatAmount": "5000",
      "fiatCurrency": ["NGN","USD","EUR","GBP","GHS","AUD","JPY"]
      "prepayOptions": {
        "collectAddress": true,
        "collectPhone": false
      },
      "postpayAction": {
        "redirect": false,
        "showConfirmationPage": false,
        "successMessage": "",
        "redirectUrl": ""
      },
      "cart": {
        "items": []
      },
      "__type": "PaymentLink"
    },
    {
      "createdAt": "2024-03-05T22:33:07.361Z",
      "updatedAt": "2024-03-18T12:44:52.287Z",
      "deletedAt": null,
      "id": "adf27a0a-ab7c-4973-862d-0da8c32140aa",
      "slug": "mkKkbOcrk2",
      "url": "https://konnadex-paylink.vercel.app/mkKkbOcrk2",
      "isActive": true,
      "visitedCount": 27,
      "paymentCount": 0,
      "title": "PAYMENT-FOR-BURIAL",
      "description": "A frnd burial donation",
      "userId": "651298c28a73710b161bda6e",
      "integratorId": "651298c28a73710b161bda70",
      "fiatAmount": "10000",
      "fiatCurrency": ["NGN","USD","EUR","GBP","GHS","AUD","JPY"]
      "prepayOptions": {
        "collectAddress": true,
        "collectPhone": true
      },
      "postpayAction": {
        "redirect": false,
        "showConfirmationPage": true,
        "successMessage": "Thank you for your payment",
        "redirectUrl": ""
      },
      "cart": {
        "items": []
      },
      "__type": "PaymentLink"
    },
    {
      "createdAt": "2024-02-29T16:04:19.975Z",
      "updatedAt": "2024-03-13T10:41:52.201Z",
      "deletedAt": null,
      "id": "bfc5cf63-3c0d-46d1-89bc-ad7fc441088c",
      "slug": "AThXtXybBp",
      "url": "https://konnadex-paylink.vercel.app/AThXtXybBp",
      "isActive": true,
      "visitedCount": 9,
      "paymentCount": 0,
      "title": "TEST-BLOCKCHAIN-PAYMENT",
      "description": "Payment for all Nigerian medical student for license",
      "userId": "651298c28a73710b161bda6e",
      "integratorId": "651298c28a73710b161bda70",
      "fiatAmount": "11",
      "fiatCurrency": ["NGN","USD","EUR","GBP","GHS","AUD","JPY"]
      "prepayOptions": {
        "collectAddress": false,
        "collectPhone": false
      },
      "postpayAction": {
        "redirect": false,
        "showConfirmationPage": false,
        "successMessage": "",
        "redirectUrl": ""
      },
      "cart": {
        "items": []
      },
      "__type": "PaymentLink"
    },
    {
      "createdAt": "2024-02-21T22:53:38.168Z",
      "updatedAt": "2024-03-04T18:06:52.821Z",
      "deletedAt": null,
      "id": "bc0dc682-9ad5-410d-b8fc-357abe135b18",
      "slug": "WGzuxv1Doq",
      "url": "https://konnadex-paylink.vercel.app/WGzuxv1Doq",
      "isActive": true,
      "visitedCount": 5,
      "paymentCount": 0,
      "title": "Testing",
      "description": "For payment of goods",
      "userId": "651298c28a73710b161bda6e",
      "integratorId": "651298c28a73710b161bda70",
      "fiatAmount": "100",
      "fiatCurrency": ["NGN","USD","EUR","GBP","GHS","AUD","JPY"]
      "prepayOptions": {
        "collectAddress": false,
        "collectPhone": false
      },
      "postpayAction": {
        "redirect": false,
        "showConfirmationPage": false,
        "successMessage": "",
        "redirectUrl": ""
      },
      "cart": {
        "items": []
      },
      "__type": "PaymentLink"
    }
  ],
  "meta": {
    "totalItems": 4,
    "itemCount": 4,
    "itemsPerPage": 20,
    "totalPages": 1,
    "currentPage": 1
  }
}
```

#### Example: Curl - Request <a href="#example-curl-request" id="example-curl-request"></a>

```javascript
curl --request GET \
     --url https://api.konnadex.com/v1/payment-link \
     --header 'accept: application/json'
```

Use this end-point to get a single payment link

### Get a single payment link with cart or without cart <a href="#get-a-single-payment-link-with-cart-or-without-cart" id="get-a-single-payment-link-with-cart-or-without-cart"></a>

`GET` `https://api.konnadex.com/v1/payment-link/{id}/single`

200: OK Update with Cart     200: OK Update with Charge

```javascript
// Some code{
   {
  "createdAt": "2024-02-29T16:04:19.975Z",
  "updatedAt": "2024-03-13T10:41:52.201Z",
  "deletedAt": null,
  "id": "bfc5cf63-3c0d-46d1-89bc-ad7fc441088c",
  "slug": "AThXtXybBp",
  "url": "https://konnadex-paylink.vercel.app/AThXtXybBp",
  "isActive": true,
  "visitedCount": 9,
  "paymentCount": 0,
  "title": "TEST-BLOCKCHAIN-PAYMENT",
  "description": "Payment for all Nigerian medical student for license",
  "userId": "651298c28a73710b161bda6e",
  "integratorId": "651298c28a73710b161bda70",
  "fiatAmount": "11",
  "fiatCurrency": ["NGN","USD","EUR","GBP","GHS","AUD","JPY"]
  "prepayOptions": {
    "collectAddress": false,
    "collectPhone": false
  },
  "postpayAction": {
    "redirect": false,
    "showConfirmationPage": false,
    "successMessage": "",
    "redirectUrl": ""
  },
  "cart": {
    "items": []
  },
  "__type": "PaymentLink"
}
```

#### Example: Curl - Request <a href="#example-curl-request-1" id="example-curl-request-1"></a>

```javascript
curl --request GET \
     --url https://api.konnadex.com/v1/payment-link/id/single \
     --header 'accept: application/json'
```
