> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.enigmagenomics.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.enigmagenomics.com/_mcp/server.

# Payment Link request for an existing invoice ID

GET https://api.enigmagenomics.com/invoices/{invoiceID}/payment-link

The **Get Payment Link** endpoint allows clients to generate or retrieve a secure payment URL associated with a specific invoice. By providing a valid `invoiceId`, the API returns a unique payment link that can be shared with the customer for completing the transaction.

This link ensures a safe and traceable payment process, tied directly to the requested invoice, and helps streamline billing workflows without exposing sensitive financial details in the request.

**Typical Use Cases:**

- Sending payment links to customers for outstanding invoices.
    
- Embedding secure payment URLs in email, SMS, or portal notifications.
    
- Automating invoice-to-payment workflows within billing or ERP systems.

Reference: https://docs.enigmagenomics.com/enigma-lis-integrations/invoices/invoice-id/payment-link-request-for-an-existing-invoice-id

## OpenAPI Specification

```yaml
openapi: 3.1.0
info:
  title: collection
  version: 1.0.0
paths:
  /invoices/{invoiceID}/payment-link:
    get:
      operationId: Payment Link request for an existing invoice ID
      summary: Payment Link request for an existing invoice ID
      description: >-
        The **Get Payment Link** endpoint allows clients to generate or retrieve
        a secure payment URL associated with a specific invoice. By providing a
        valid `invoiceId`, the API returns a unique payment link that can be
        shared with the customer for completing the transaction.


        This link ensures a safe and traceable payment process, tied directly to
        the requested invoice, and helps streamline billing workflows without
        exposing sensitive financial details in the request.


        **Typical Use Cases:**


        - Sending payment links to customers for outstanding invoices.
            
        - Embedding secure payment URLs in email, SMS, or portal notifications.
            
        - Automating invoice-to-payment workflows within billing or ERP systems.
      tags:
        - invoiceId
      parameters:
        - name: invoiceID
          in: path
          required: true
          schema:
            type: string
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/invoices_{invoiceID}_Payment Link request
                  for an existing invoice ID_Response_200
servers:
  - url: https://api.enigmagenomics.com
    description: https://api.enigmagenomics.com
components:
  schemas:
    InvoicesInvoiceIdPaymentLinkGetResponsesContentApplicationJsonSchemaData:
      type: object
      properties:
        payment_link:
          type: string
          format: uri
      required:
        - payment_link
      title: InvoicesInvoiceIdPaymentLinkGetResponsesContentApplicationJsonSchemaData
    invoices_{invoiceID}_Payment Link request for an existing invoice ID_Response_200:
      type: object
      properties:
        code:
          type: integer
        data:
          $ref: >-
            #/components/schemas/InvoicesInvoiceIdPaymentLinkGetResponsesContentApplicationJsonSchemaData
        message:
          type: string
      required:
        - code
        - data
        - message
      title: >-
        invoices_{invoiceID}_Payment Link request for an existing invoice
        ID_Response_200
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key

```

## Examples



**Response**

```json
{
  "code": 200,
  "data": {
    "payment_link": "https://payment.link/dummy_link"
  },
  "message": "Payment link generated successfully."
}
```

**SDK Code**

```python Payment Link request for an existing invoice ID
import requests

url = "https://api.enigmagenomics.com/invoices/:invoiceID/payment-link"

headers = {"x-api-key": "<apiKey>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript Payment Link request for an existing invoice ID
const url = 'https://api.enigmagenomics.com/invoices/:invoiceID/payment-link';
const options = {method: 'GET', headers: {'x-api-key': '<apiKey>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Payment Link request for an existing invoice ID
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.enigmagenomics.com/invoices/:invoiceID/payment-link"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<apiKey>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Payment Link request for an existing invoice ID
require 'uri'
require 'net/http'

url = URI("https://api.enigmagenomics.com/invoices/:invoiceID/payment-link")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<apiKey>'

response = http.request(request)
puts response.read_body
```

```java Payment Link request for an existing invoice ID
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.enigmagenomics.com/invoices/:invoiceID/payment-link")
  .header("x-api-key", "<apiKey>")
  .asString();
```

```php Payment Link request for an existing invoice ID
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.enigmagenomics.com/invoices/:invoiceID/payment-link', [
  'headers' => [
    'x-api-key' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp Payment Link request for an existing invoice ID
using RestSharp;

var client = new RestClient("https://api.enigmagenomics.com/invoices/:invoiceID/payment-link");
var request = new RestRequest(Method.GET);
request.AddHeader("x-api-key", "<apiKey>");
IRestResponse response = client.Execute(request);
```

```swift Payment Link request for an existing invoice ID
import Foundation

let headers = ["x-api-key": "<apiKey>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.enigmagenomics.com/invoices/:invoiceID/payment-link")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```