# Create a new payment link

Create a new payment link for an invoice, adhoc invoice or customer

Endpoint: POST /payment-provider-payment-link
Version: 1.37
Security: bearerAuth

## Request fields (application/json):

  - `paymentProviderId` (integer, required)
    Payment provider identifier
    Example: 1

  - `amountInMajorCurrency` (number, required)
    Amount in major currency (e.g pounds/dollars/euros)
    Example: 10.5

  - `description` (string, required)
    Description of the payment

  - `emailAddress` (string)
    Customer email address

  - `invoiceId` (integer)
    Invoice identifier, if payment is for an invoice
    Example: 1

  - `adhocInvoiceId` (integer)
    adhoc invoice identifier, if payment is for an adhoc invoice
    Example: 1

  - `customerId` (integer)
    Customer identifier, if payment is for a customer
    Example: 1

## Response 200 fields (application/json):

  - `id` (integer)
    Payment link identifier
    Example: 1

  - `paymentProviderId` (integer, required)
    Payment provider identifier
    Example: 1

  - `amountInMajorCurrency` (number, required)
    Amount in major currency (e.g pounds/dollars/euros)
    Example: 10.5

  - `currencyId` (integer)
    Currency Id
    Example: 1

  - `description` (string, required)
    Description of the payment

  - `emailAddress` (string)
    Customer email address

  - `invoiceId` (integer)
    Invoice identifier, if payment is for an invoice
    Example: 1

  - `adhocInvoiceId` (integer)
    adhoc invoice identifier, if payment is for an adhoc invoice
    Example: 1

  - `customerId` (integer)
    Customer identifier, if payment is for a customer
    Example: 1

  - `paymentLink` (string)
    Generated instant payment link
    Example: "https://instantpaymentlink/exampleref"

## Response 201 fields (application/json):

  - `id` (integer)
    Payment link identifier
    Example: 1

  - `paymentProviderId` (integer, required)
    Payment provider identifier
    Example: 1

  - `amountInMajorCurrency` (number, required)
    Amount in major currency (e.g pounds/dollars/euros)
    Example: 10.5

  - `currencyId` (integer)
    Currency Id
    Example: 1

  - `description` (string, required)
    Description of the payment

  - `emailAddress` (string)
    Customer email address

  - `invoiceId` (integer)
    Invoice identifier, if payment is for an invoice
    Example: 1

  - `adhocInvoiceId` (integer)
    adhoc invoice identifier, if payment is for an adhoc invoice
    Example: 1

  - `customerId` (integer)
    Customer identifier, if payment is for a customer
    Example: 1

  - `paymentLink` (string)
    Generated instant payment link
    Example: "https://instantpaymentlink/exampleref"


## Response 400 fields

## Response 401 fields

## Response 403 fields