---
title: "Create a payment link"
method: POST
path: "/api/paymentlink/new"
tags: ["PaymentLink"]
---

# Create a payment link

`POST /api/paymentlink/new`

## Headers

- `x-auth-key` string, required
- `x-auth-secret` string, required

## Request body

- PaymentLink
  - `Number` string
  - `AccessToken` string
  - `CurrencyId` integer
  - `Currency` Currency
    - `Name` string
    - `Value` string
    - `Code` string
    - `Symbol` string
    - `Id` integer
  - `ClientId` integer
  - `Client` Client
    - `ClientCurrencyId` integer
    - `ClientCountryId` integer
    - `UiLanguageId` integer
    - `Name` string
    - `Address` string
    - `Email` string
    - `PhoneNumber` string
    - `Vat` string
    - `CompanyRegistrationNumber` string
    - `DefaultDueDateInDays` integer
    - `UserId` integer
    - `Id` integer
  - `User` User
    - `Username` string
    - `Password` string
    - `PasswordSalt` string
    - `Email` string
    - `Name` string
    - `Type` 'Anonymous' | 'Customer' | 'SystemAdministrator' | 'Collaborator'
    - `Status` 'Normal' | 'Fraudlent' | 'Locked'
    - `YearsOfExperience` 'One' | 'OneToThree' | 'ThreeToFive' | 'SixPlus'
    - `IsVerified` boolean
    - `IsLocked` boolean
    - `HasBeenOnboarded` boolean
    - `VerifiedOn` string, date-time
    - `LastSeenOn` string, date-time
    - `ActionNotificationsLastReadOn` string, date-time
    - `KnowledgeNotificationsLastReadOn` string, date-time
    - `ReferralPath` string
    - `ReferrerKey` string
    - `ReferredUsers` integer
    - `Settings` UserSettings
      - `HasInvoiceLogo` boolean
      - `Profession` 'Other' | 'DesignAndCreative' | 'SoftwareDevelopment' | 'ContentWritingAndMarketing' | 'Freelancers' | 'Consultants' | 'Smes' | 'Enterprise' | 'ECommerce' | 'Individual'
      - `YearsOfExperience` integer
      - `BackgroundImage` string
      - `Currency` Currency
        - `Name` string
        - `Value` string
        - `Code` string
        - `Symbol` string
        - `Id` integer
      - `CurrencyId` integer
      - `CurrencySymbol` string
      - `Country` Country
        - `Name` string
        - `Value` string
        - `Id` integer
      - `CountryId` integer
      - `Address` string
      - `PhoneNumber` string
      - `SubscribeToProductEmails` boolean
      - `ReceiveSmsNotifications` boolean
      - `AccountantEmail` string
      - `VatNumber` string
      - `CompanyRegistrationNumber` string
      - `Terms` string
      - `DefaultDateFormat` string
      - `Bank` string
      - `BankAccount` string
      - `Iban` string
      - `Swift` string
      - `EnableRecurringInvoicing` boolean
      - `EnablePredictiveInvoicing` boolean
      - `EnableClientPortal` boolean
      - `DefaultDueDateInDays` integer
      - `UserSignature` string
      - `InvoiceTemplate` 'Default' | 'Template1' | 'Template2'
      - `InvoiceTemplateColorHex` string
      - `ReferralProgram` 'Enabled' | 'Disabled'
      - `ApiKey` string
      - `ApiSecret` string
      - `DoNotTrack` boolean
      - `StoreName` string
      - `StoreDescription` string
      - `StoreUrl` string
      - `StoreLanguage` UiLanguage
        - `Name` string
        - `UiCulture` string
        - `Id` integer
      - `StoreLanguageId` integer
      - `StoreCurrency` Currency
        - `Name` string
        - `Value` string
        - `Code` string
        - `Symbol` string
        - `Id` integer
      - `StoreCurrencyId` integer
      - `StoreColorHex` string
      - `StoreTextColorHex` string
      - `StoreEmail` string
      - `StorePurchaseThankYouMessage` string
      - `StorePurchaseEmailMessage` string
      - `StoreCustomJavaScript` string
      - `StoreCheckoutFields` 'ShowMinimumRequiredFields' | 'ShowAllFields'
      - `Cname` string
      - `UserId` integer
      - `Id` integer
    - `SubscriptionPlan` SubscriptionPlan
      - `Identifier` string
      - `ExternalIdentifier` string
      - `Version` integer
      - `OrderIdentifier` string
      - `SaleId` integer
      - `Name` string
      - `MaxClients` integer
      - `Price` number, double
      - `CurrencyCode` string
      - `Recurrence` 'Monthly' | 'Yearly'
      - `TrialStartsOn` string, date-time
      - `TrialEndsOn` string, date-time
      - `TrialNumberOfDays` integer
      - `IsActive` boolean
      - `Status` 'ActiveTrial' | 'ExpiredTrial' | 'Active' | 'Canceled' | 'Fraudlent'
      - `CancellatedOn` string, date-time
      - `SystemCancelationReason` 'FailToCaptureFee' | 'Fraud'
      - `LastPaymentOn` string, date-time
      - `HasDuePayment` boolean
      - `HasDuePaymentSince` string, date-time
      - `OnHold` boolean
      - `IsLifetime` boolean
      - `CouponCode` string
      - `Features` string[]
      - `UserId` integer
      - `Id` integer
    - `ExternalConnections` ExternalConnection[]
      - `Provider` string
      - `AccessToken` string
      - `AccessTokenSecret` string
      - `ExternalUserId` string
      - `ExternalUsername` string
      - `Data` string
      - `ExpiresOn` string, date-time
      - `UserId` integer
      - `Id` integer
    - `Id` integer
  - `Invoice` Invoice
    - `ClientId` integer
    - `ClonedFromId` integer
    - `RecurringProfileId` integer
    - `Number` string
    - `IssuedOn` string, date-time
    - `Duedate` string, date-time
    - `PoNumber` string
    - `DiscountAmount` number, double
    - `TaxAmount` number, double
    - `SubTotalAmount` number, double
    - `TotalAmount` number, double
    - `Terms` string
    - `Notes` string
    - `Status` 'Draft' | 'Paid' | 'Unpaid' | 'Overdue' | 'Void'
    - `CurrencyId` integer
    - `EnablePartialPayments` boolean
    - `AccessToken` string
    - `OrderId` integer
    - `PaymentLinkId` integer
    - `EstimationId` integer
    - `InvoiceCategoryId` integer
    - `Items` InvoiceItem[]
      - `InvoiceId` integer
      - `WorkTypeId` integer
      - `Description` string
      - `Cost` number, double
      - `Quantity` number, double
      - `DiscountPercentage` number, double
      - `TaxId` integer
      - `TaxPercentage` number, double
      - `DiscountAmount` number, double
      - `TaxAmount` number, double
      - `SubTotalAmount` number, double
      - `TotalAmount` number, double
      - `Id` integer
    - `Attachments` InvoiceAttachment[]
      - `InvoiceId` integer
      - `Link` string
      - `Size` integer
      - `Type` 'External' | 'Uploaded'
      - `OriginalFileName` string
      - `ObfuscatedFileName` string
      - `Id` integer
    - `Payments` Payment[]
      - `Invoice` Invoice — recursive
      - `InvoiceId` integer
      - `Note` string
      - `PaidOn` string, date-time
      - `Amount` number, double
      - `Type` 'Other' | 'Paypal' | 'Stripe' | 'Payoneer' | 'Bank' | 'Cash' | 'Cheque' | 'Ach' | 'Sepa' | 'Square' | 'KlikAndPay' | 'Razorpay' | 'Wepay' | 'Halkbank' | 'TwoCheckout' | 'PaymentWall' | 'BamboraEU' | 'BamboraNA' | 'Nlb' | 'AuthorizeNet' | 'Braintree'
      - `IsAutomatic` boolean
      - `ReferenceId` string
      - `Id` integer
    - `Activities` Activity[]
      - `InvoiceId` integer
      - `InvoiceNumber` string
      - `EstimationId` integer
      - `EstimationNumber` string
      - `OrderId` integer
      - `OrderNumber` string
      - `Type` 'Created' | 'Draft' | 'Cloned' | 'SentViaEmail' | 'SentViaSms' | 'SentReminderViaEmail' | 'SentReminderViaSms' | 'Opened' | 'Viewed' | 'Rejected' | 'Updated' | 'Paid' | 'Unpaid' | 'Overdue' | 'NewManualPayment' | 'NewPaymentWithPaypal' | 'NewPaymentWithStripe' | 'NewPaymentWithPayoneer' | 'SentToAccountant' | 'DownloadedAsPdf' | 'MarkAsPaidByTheClient' | 'OpenedAttachment' | 'NewPaymentWithSquare' | 'NewPaymentWithKlikAndPay' | 'NewPaymentWithRazorpay' | 'NewPaymentWithWepay' | 'NewPaymentWithHalkbank' | 'ChangeStatus' | 'OrderUpdated' | 'OrderCreated' | 'NewPaymentWithTwoCheckout' | 'NewPaymentWithPaymentWall' | 'NewPaymentWithBamboraEU' | 'NewPaymentWithBamboraNA' | 'Void' | 'NewPaymentWithNlb' | 'NewPaymentWithAuthorizeNet' | 'NewPaymentWithBraintree' | 'EstimationCreated' | 'EstimationDraft' | 'EstimationCloned' | 'EstimationSentViaEmail' | 'EstimationOpened' | 'EstimationViewed' | 'EstimationAccepted' | 'EstimationRejected' | 'EstimationUpdated' | 'EstimationDownloadedAsPdf' | 'InvoiceDigitallySigned'
      - `Message` string
      - `Link` string
      - `UserId` integer
      - `Id` integer
    - `PaymentGateways` PaymentGatewayForInvoice[]
      - `Name` string
      - `Id` integer
    - `ShouldSendReminders` boolean
    - `IsDigitallySigned` boolean
    - `UserId` integer
    - `Id` integer
  - `Items` PaymentLinkItem[]
    - `PaymentLinkId` integer
    - `WorkTypeId` integer
    - `WorkType` WorkType
      - `Title` string
      - `UserId` integer
      - `Id` integer
    - `Cost` number, double
    - `DiscountAmount` number, double
    - `DiscountPercentage` number, double
    - `Quantity` number, double
    - `SubTotalAmount` number, double
    - `Tax` Tax
      - `Name` string
      - `Percentage` number, double
      - `UserId` integer
      - `Id` integer
    - `TaxAmount` number, double
    - `TaxId` integer
    - `TaxPercentage` number, double
    - `TotalAmount` number, double
    - `Id` integer
  - `DiscountAmount` number, double
  - `TaxAmount` number, double
  - `SubTotalAmount` number, double
  - `TotalAmount` number, double
  - `UserId` integer
  - `Id` integer

## Response `200`

OK

- integer

---

[API](https://skmtc.dev/envoice/apis/api-v1-0-0.md) · [All operations](https://skmtc.dev/envoice/apis/api-v1-0-0/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/envoice/api-v1-0-0/revisions/e20a9e338d8f/schema)